mirror of
				https://github.com/zulip/zulip.git
				synced 2025-10-31 12:03:46 +00:00 
			
		
		
		
	Compare commits
	
		
			248 Commits
		
	
	
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
|  | c7f3811f09 | ||
|  | 7a53ccfb1c | ||
|  | 8c31437dd1 | ||
|  | e6eace307e | ||
|  | c28d1169c3 | ||
|  | d525cf8f9d | ||
|  | 93f13ff2f5 | ||
|  | 4eaf9d7e55 | ||
|  | aaf0e1d93b | ||
|  | 0d72a12ffa | ||
|  | 4bb22d2535 | ||
|  | c93cef91e8 | ||
|  | 0c227217b2 | ||
|  | b5c7a79bdf | ||
|  | 7e991c8c7e | ||
|  | 974c98a45a | ||
|  | 5784bdd0ed | ||
|  | e10ea15aa9 | ||
|  | d860242220 | ||
|  | b2c3f5e510 | ||
|  | 232fe495be | ||
|  | c20afad828 | ||
|  | 3fad49a9c1 | ||
|  | cc95aac176 | ||
|  | 1b27ec9fae | ||
|  | ebd74239a2 | ||
|  | 8dcb1e489d | ||
|  | 4e7419e168 | ||
|  | 8567e19fff | ||
|  | 9aa7c19891 | ||
|  | 4fdbf274ac | ||
|  | 218eca14b8 | ||
|  | 08efebbaff | ||
|  | 1c819208d0 | ||
|  | 8424649c70 | ||
|  | 33d8c190d8 | ||
|  | 0213b811ec | ||
|  | c27324927e | ||
|  | c087ed4c26 | ||
|  | ffc1f81cde | ||
|  | 90b6fe2c6e | ||
|  | 36cebad4c0 | ||
|  | f33fbb527c | ||
|  | 134a8d4301 | ||
|  | a07f64a463 | ||
|  | e9af26df6e | ||
|  | 7f6b423532 | ||
|  | d95fb34ba7 | ||
|  | 5ff759d35c | ||
|  | a0d1074212 | ||
|  | 2e1e2b08f1 | ||
|  | b44a1b68f6 | ||
|  | c3adbcea13 | ||
|  | e088b343b3 | ||
|  | 1d559bbffa | ||
|  | cb24f93bba | ||
|  | 868180a25d | ||
|  | 20fc1f651a | ||
|  | 0d79d6735a | ||
|  | 45568a08c0 | ||
|  | 22152a0662 | ||
|  | 9bbb336441 | ||
|  | 3d966f1af9 | ||
|  | ab98f3801f | ||
|  | ddca8a7f9a | ||
|  | c1c3dfced5 | ||
|  | 2d3f505505 | ||
|  | d3573af95c | ||
|  | 859d88f76c | ||
|  | 9a0fb497a4 | ||
|  | 7ea4ad75af | ||
|  | ae000bfdba | ||
|  | 551b387164 | ||
|  | 720d16e809 | ||
|  | f338ff64c3 | ||
|  | 98610c984c | ||
|  | ab965e5892 | ||
|  | 7a03827047 | ||
|  | 5954e622bc | ||
|  | 687db48ea8 | ||
|  | 399391c3aa | ||
|  | cd5eec5eea | ||
|  | e7d48c0c10 | ||
|  | 023dfc01ba | ||
|  | 5d9285fff3 | ||
|  | 53f353ec26 | ||
|  | 245c87c567 | ||
|  | 26aa4d57e3 | ||
|  | bee225782a | ||
|  | 4a6e69357a | ||
|  | 3e6d3810d4 | ||
|  | bc21dde235 | ||
|  | 182ce488e2 | ||
|  | bd557a9a13 | ||
|  | 7e8ead7325 | ||
|  | 8fa783f13d | ||
|  | 11924f4b66 | ||
|  | f01cbba0ce | ||
|  | 31050be173 | ||
|  | 56d857ca89 | ||
|  | d587252ddb | ||
|  | eadefdf2f5 | ||
|  | c05bbd0fd4 | ||
|  | deedda2c18 | ||
|  | 9bec6bb5eb | ||
|  | 634b6ea97b | ||
|  | 10583bdb32 | ||
|  | ebb6a92f71 | ||
|  | 80b7df1b0d | ||
|  | 7b6cee1164 | ||
|  | 99cc5598ac | ||
|  | d23778869f | ||
|  | 6ba333c2ff | ||
|  | 3cf07d1671 | ||
|  | 1b4832a703 | ||
|  | af5958e407 | ||
|  | a659944fe3 | ||
|  | 19db2fa773 | ||
|  | b303477e86 | ||
|  | 5c01e23776 | ||
|  | 4e724c1ec6 | ||
|  | e2d303c1bb | ||
|  | d3091a6096 | ||
|  | 313bcfd02a | ||
|  | 09bfd485e9 | ||
|  | 576ae9cc9f | ||
|  | 300447ddd9 | ||
|  | f8149b0d5a | ||
|  | b579dad7d9 | ||
|  | fdfabb800d | ||
|  | 2c4156678c | ||
|  | 0a87276a27 | ||
|  | 19aed43817 | ||
|  | d370aefe3a | ||
|  | 0f5657b0ed | ||
|  | 24277a144e | ||
|  | df8b8b9836 | ||
|  | 64fab06adb | ||
|  | 9391840d34 | ||
|  | 658e641d12 | ||
|  | 467723145b | ||
|  | 4ce37176db | ||
|  | 82bf185b1b | ||
|  | d81ce3ba76 | ||
|  | aa6e70382d | ||
|  | 0147c6adce | ||
|  | 5ae8fe292d | ||
|  | 2e8d8ca044 | ||
|  | ec0835b947 | ||
|  | e5e7e58c99 | ||
|  | 6a6c6d469b | ||
|  | 34512727e4 | ||
|  | da3396b4d7 | ||
|  | 3f1b444a9a | ||
|  | d5a5d0a3e7 | ||
|  | bac90f6a9d | ||
|  | 9fbfdb0aca | ||
|  | 7fe1e55483 | ||
|  | cb0d29d845 | ||
|  | 1c83ebfc71 | ||
|  | 8d040d36ed | ||
|  | f4b955f2ee | ||
|  | aa3f9004ba | ||
|  | 90bf44bde0 | ||
|  | dbb7bc824c | ||
|  | 3d4071fea7 | ||
|  | eb7464c68d | ||
|  | 1c2deb0cd3 | ||
|  | 26f4ab9a9d | ||
|  | 5feba78939 | ||
|  | 04600acbbb | ||
|  | 6ffbb6081b | ||
|  | 1f2767f940 | ||
|  | 9173ed0fb9 | ||
|  | 303bde6c55 | ||
|  | bc118496a2 | ||
|  | f118da6b86 | ||
|  | 1ba708ca96 | ||
|  | e156db2bc7 | ||
|  | d0235add03 | ||
|  | a6b06df895 | ||
|  | 2df2f7eec6 | ||
|  | ad858d2c79 | ||
|  | 5290f17adb | ||
|  | 9824a9d7cf | ||
|  | 88a2a80d81 | ||
|  | 5b16ee0c08 | ||
|  | 17dced26ff | ||
|  | fc9c5b1f43 | ||
|  | 564873a207 | ||
|  | c692263255 | ||
|  | bfe428f608 | ||
|  | d200e3547f | ||
|  | b6afa4a82b | ||
|  | 4db187856d | ||
|  | 36638c95b9 | ||
|  | 85f14eb4f7 | ||
|  | 0fab79c027 | ||
|  | 7d46bed507 | ||
|  | a89ba9c7d6 | ||
|  | 8f735f4683 | ||
|  | e7cfd30d53 | ||
|  | 10c8c0e071 | ||
|  | 9f8b5e225d | ||
|  | 62194eb20f | ||
|  | 2492f4b60e | ||
|  | 1b2967ddb5 | ||
|  | 42774b101f | ||
|  | 716cba04de | ||
|  | 332add3bb6 | ||
|  | b596cd7607 | ||
|  | 21cedabbdf | ||
|  | f910d5b8a9 | ||
|  | daf185705d | ||
|  | 1fa7081a4c | ||
|  | 0d17a5e76d | ||
|  | 9815581957 | ||
|  | 33d7aa9d47 | ||
|  | 6c3a6ef6c1 | ||
|  | a63150ca35 | ||
|  | 7ab8455596 | ||
|  | 43be62c7ef | ||
|  | 7b15ce71c2 | ||
|  | 96c5a9e303 | ||
|  | 0b337e0819 | ||
|  | d4b3c20e48 | ||
|  | 31be0f04b9 | ||
|  | 6af0e28e5d | ||
|  | 9cb538b08f | ||
|  | bf49f962c0 | ||
|  | 2a69b4f3b7 | ||
|  | 540904aa9d | ||
|  | 26bdf79642 | ||
|  | 2c1ffaceca | ||
|  | dffff73654 | ||
|  | 2f9d4f5a96 | ||
|  | ce96018af4 | ||
|  | a025fab082 | ||
|  | 812ad52007 | ||
|  | 9066fcac9a | ||
|  | a70ebdb005 | ||
|  | 956d4b2568 | ||
|  | ea2256da29 | ||
|  | d1bd8f3637 | ||
|  | 22d486bbf7 | ||
|  | 977ff62fe8 | ||
|  | 5bfc162df9 | ||
|  | 2aa643502a | 
							
								
								
									
										5
									
								
								.browserslistrc
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										5
									
								
								.browserslistrc
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,5 @@ | ||||
| > 0.15% | ||||
| > 0.15% in US | ||||
| last 2 versions | ||||
| Firefox ESR | ||||
| not dead | ||||
| @@ -1,30 +0,0 @@ | ||||
| te | ||||
| ans | ||||
| pullrequest | ||||
| ist | ||||
| cros | ||||
| wit | ||||
| nwe | ||||
| circularly | ||||
| ned | ||||
| ba | ||||
| ressemble | ||||
| ser | ||||
| sur | ||||
| hel | ||||
| fpr | ||||
| alls | ||||
| nd | ||||
| ot | ||||
| womens | ||||
| vise | ||||
| falsy | ||||
| ro | ||||
| derails | ||||
| forin | ||||
| uper | ||||
| slac | ||||
| couldn | ||||
| ges | ||||
| assertIn | ||||
| thirdparty | ||||
| @@ -8,9 +8,8 @@ indent_style = space | ||||
| insert_final_newline = true | ||||
| trim_trailing_whitespace = true | ||||
|  | ||||
| [[shell]] | ||||
| binary_next_line = true | ||||
| switch_case_indent = true | ||||
| binary_next_line = true  # for shfmt | ||||
| switch_case_indent = true  # for shfmt | ||||
|  | ||||
| [{*.{js,json,ts},check-openapi}] | ||||
| max_line_length = 100 | ||||
|   | ||||
| @@ -4,12 +4,11 @@ | ||||
|  | ||||
| /docs/_build | ||||
| /static/generated | ||||
| /static/third | ||||
| /static/webpack-bundles | ||||
| /var/* | ||||
| !/var/puppeteer | ||||
| /var/puppeteer/* | ||||
| !/var/puppeteer/test_credentials.d.ts | ||||
| /web/generated | ||||
| /web/third | ||||
| /zulip-current-venv | ||||
| /zulip-py3-venv | ||||
|   | ||||
							
								
								
									
										293
									
								
								.eslintrc.js
									
									
									
									
									
								
							
							
						
						
									
										293
									
								
								.eslintrc.js
									
									
									
									
									
								
							| @@ -1,293 +0,0 @@ | ||||
| "use strict"; | ||||
|  | ||||
| const confusingBrowserGlobals = require("confusing-browser-globals"); | ||||
|  | ||||
| module.exports = { | ||||
|     root: true, | ||||
|     env: { | ||||
|         es2020: true, | ||||
|         node: true, | ||||
|     }, | ||||
|     extends: [ | ||||
|         "eslint:recommended", | ||||
|         "plugin:import/errors", | ||||
|         "plugin:import/warnings", | ||||
|         "plugin:no-jquery/recommended", | ||||
|         "plugin:no-jquery/deprecated", | ||||
|         "plugin:unicorn/recommended", | ||||
|         "prettier", | ||||
|     ], | ||||
|     parser: "@babel/eslint-parser", | ||||
|     parserOptions: { | ||||
|         requireConfigFile: false, | ||||
|         warnOnUnsupportedTypeScriptVersion: false, | ||||
|         sourceType: "unambiguous", | ||||
|     }, | ||||
|     plugins: ["formatjs", "no-jquery"], | ||||
|     settings: { | ||||
|         formatjs: { | ||||
|             additionalFunctionNames: ["$t", "$t_html"], | ||||
|         }, | ||||
|         "no-jquery": { | ||||
|             collectionReturningPlugins: { | ||||
|                 expectOne: "always", | ||||
|             }, | ||||
|             variablePattern: "^\\$(?!t$|t_html$).", | ||||
|         }, | ||||
|     }, | ||||
|     reportUnusedDisableDirectives: true, | ||||
|     rules: { | ||||
|         "array-callback-return": "error", | ||||
|         "arrow-body-style": "error", | ||||
|         "block-scoped-var": "error", | ||||
|         "consistent-return": "error", | ||||
|         curly: "error", | ||||
|         "dot-notation": "error", | ||||
|         eqeqeq: "error", | ||||
|         "formatjs/enforce-default-message": ["error", "literal"], | ||||
|         "formatjs/enforce-placeholders": [ | ||||
|             "error", | ||||
|             {ignoreList: ["b", "code", "em", "i", "kbd", "p", "strong"]}, | ||||
|         ], | ||||
|         "formatjs/no-id": "error", | ||||
|         "guard-for-in": "error", | ||||
|         "import/extensions": "error", | ||||
|         "import/first": "error", | ||||
|         "import/newline-after-import": "error", | ||||
|         "import/no-cycle": ["error", {ignoreExternal: true}], | ||||
|         "import/no-duplicates": "error", | ||||
|         "import/no-self-import": "error", | ||||
|         "import/no-unresolved": "off", | ||||
|         "import/no-useless-path-segments": "error", | ||||
|         "import/order": ["error", {alphabetize: {order: "asc"}, "newlines-between": "always"}], | ||||
|         "import/unambiguous": "error", | ||||
|         "lines-around-directive": "error", | ||||
|         "new-cap": "error", | ||||
|         "no-alert": "error", | ||||
|         "no-array-constructor": "error", | ||||
|         "no-bitwise": "error", | ||||
|         "no-caller": "error", | ||||
|         "no-catch-shadow": "error", | ||||
|         "no-constant-condition": ["error", {checkLoops: false}], | ||||
|         "no-div-regex": "error", | ||||
|         "no-else-return": "error", | ||||
|         "no-eq-null": "error", | ||||
|         "no-eval": "error", | ||||
|         "no-implicit-coercion": "error", | ||||
|         "no-implied-eval": "error", | ||||
|         "no-inner-declarations": "off", | ||||
|         "no-iterator": "error", | ||||
|         "no-jquery/no-append-html": "error", | ||||
|         "no-jquery/no-constructor-attributes": "error", | ||||
|         "no-jquery/no-parse-html-literal": "error", | ||||
|         "no-label-var": "error", | ||||
|         "no-labels": "error", | ||||
|         "no-loop-func": "error", | ||||
|         "no-multi-str": "error", | ||||
|         "no-native-reassign": "error", | ||||
|         "no-new-func": "error", | ||||
|         "no-new-object": "error", | ||||
|         "no-new-wrappers": "error", | ||||
|         "no-octal-escape": "error", | ||||
|         "no-plusplus": "error", | ||||
|         "no-proto": "error", | ||||
|         "no-restricted-globals": ["error", ...confusingBrowserGlobals], | ||||
|         "no-return-assign": "error", | ||||
|         "no-script-url": "error", | ||||
|         "no-self-compare": "error", | ||||
|         "no-sync": "error", | ||||
|         "no-throw-literal": "error", | ||||
|         "no-undef-init": "error", | ||||
|         "no-unneeded-ternary": ["error", {defaultAssignment: false}], | ||||
|         "no-unused-expressions": "error", | ||||
|         "no-unused-vars": [ | ||||
|             "error", | ||||
|             {args: "all", argsIgnorePattern: "^_", ignoreRestSiblings: true}, | ||||
|         ], | ||||
|         "no-use-before-define": ["error", {functions: false}], | ||||
|         "no-useless-concat": "error", | ||||
|         "no-useless-constructor": "error", | ||||
|         "no-var": "error", | ||||
|         "object-shorthand": ["error", "always", {avoidExplicitReturnArrows: true}], | ||||
|         "one-var": ["error", "never"], | ||||
|         "prefer-arrow-callback": "error", | ||||
|         "prefer-const": ["error", {ignoreReadBeforeAssign: true}], | ||||
|         radix: "error", | ||||
|         "sort-imports": ["error", {ignoreDeclarationSort: true}], | ||||
|         "spaced-comment": ["error", "always", {markers: ["/"]}], | ||||
|         strict: "error", | ||||
|         "unicorn/consistent-function-scoping": "off", | ||||
|         "unicorn/explicit-length-check": "off", | ||||
|         "unicorn/filename-case": "off", | ||||
|         "unicorn/no-await-expression-member": "off", | ||||
|         "unicorn/no-negated-condition": "off", | ||||
|         "unicorn/no-null": "off", | ||||
|         "unicorn/no-process-exit": "off", | ||||
|         "unicorn/no-useless-undefined": "off", | ||||
|         "unicorn/numeric-separators-style": "off", | ||||
|         "unicorn/prefer-module": "off", | ||||
|         "unicorn/prefer-node-protocol": "off", | ||||
|         "unicorn/prefer-string-raw": "off", | ||||
|         "unicorn/prefer-ternary": "off", | ||||
|         "unicorn/prefer-top-level-await": "off", | ||||
|         "unicorn/prevent-abbreviations": "off", | ||||
|         "unicorn/switch-case-braces": "off", | ||||
|         "valid-typeof": ["error", {requireStringLiterals: true}], | ||||
|         yoda: "error", | ||||
|     }, | ||||
|     overrides: [ | ||||
|         { | ||||
|             files: ["web/tests/**"], | ||||
|             rules: { | ||||
|                 "no-jquery/no-selector-prop": "off", | ||||
|             }, | ||||
|         }, | ||||
|         { | ||||
|             files: ["web/e2e-tests/**"], | ||||
|             globals: { | ||||
|                 zulip_test: false, | ||||
|             }, | ||||
|         }, | ||||
|         { | ||||
|             files: ["web/src/**"], | ||||
|             globals: { | ||||
|                 StripeCheckout: false, | ||||
|             }, | ||||
|         }, | ||||
|         { | ||||
|             files: ["**/*.ts"], | ||||
|             extends: [ | ||||
|                 "plugin:@typescript-eslint/strict-type-checked", | ||||
|                 "plugin:@typescript-eslint/stylistic-type-checked", | ||||
|                 "plugin:import/typescript", | ||||
|             ], | ||||
|             parserOptions: { | ||||
|                 project: "tsconfig.json", | ||||
|             }, | ||||
|             settings: { | ||||
|                 "import/resolver": { | ||||
|                     node: { | ||||
|                         extensions: [".ts", ".d.ts", ".js"], // https://github.com/import-js/eslint-plugin-import/issues/2267 | ||||
|                     }, | ||||
|                 }, | ||||
|             }, | ||||
|             globals: { | ||||
|                 JQuery: false, | ||||
|             }, | ||||
|             rules: { | ||||
|                 // Disable base rule to avoid conflict | ||||
|                 "no-use-before-define": "off", | ||||
|  | ||||
|                 "@typescript-eslint/consistent-type-assertions": [ | ||||
|                     "error", | ||||
|                     {assertionStyle: "never"}, | ||||
|                 ], | ||||
|                 "@typescript-eslint/consistent-type-definitions": ["error", "type"], | ||||
|                 "@typescript-eslint/consistent-type-imports": "error", | ||||
|                 "@typescript-eslint/explicit-function-return-type": [ | ||||
|                     "error", | ||||
|                     {allowExpressions: true}, | ||||
|                 ], | ||||
|                 "@typescript-eslint/member-ordering": "error", | ||||
|                 "@typescript-eslint/method-signature-style": "error", | ||||
|                 "@typescript-eslint/no-non-null-assertion": "off", | ||||
|                 "@typescript-eslint/no-unnecessary-condition": "off", | ||||
|                 "@typescript-eslint/no-unnecessary-qualifier": "error", | ||||
|                 "@typescript-eslint/no-unused-vars": [ | ||||
|                     "error", | ||||
|                     {args: "all", argsIgnorePattern: "^_", ignoreRestSiblings: true}, | ||||
|                 ], | ||||
|                 "@typescript-eslint/no-use-before-define": ["error", {functions: false}], | ||||
|                 "@typescript-eslint/parameter-properties": "error", | ||||
|                 "@typescript-eslint/promise-function-async": "error", | ||||
|                 "@typescript-eslint/restrict-plus-operands": ["error", {}], | ||||
|                 "@typescript-eslint/restrict-template-expressions": ["error", {}], | ||||
|                 "no-undef": "error", | ||||
|             }, | ||||
|         }, | ||||
|         { | ||||
|             files: ["**/*.d.ts"], | ||||
|             rules: { | ||||
|                 "import/unambiguous": "off", | ||||
|             }, | ||||
|         }, | ||||
|         { | ||||
|             files: ["web/e2e-tests/**", "web/tests/**"], | ||||
|             globals: { | ||||
|                 CSS: false, | ||||
|                 document: false, | ||||
|                 navigator: false, | ||||
|                 window: false, | ||||
|             }, | ||||
|             rules: { | ||||
|                 "formatjs/no-id": "off", | ||||
|                 "new-cap": "off", | ||||
|                 "no-sync": "off", | ||||
|                 "unicorn/prefer-prototype-methods": "off", | ||||
|             }, | ||||
|         }, | ||||
|         { | ||||
|             files: ["web/debug-require.js"], | ||||
|             env: { | ||||
|                 browser: true, | ||||
|                 es2020: false, | ||||
|             }, | ||||
|             rules: { | ||||
|                 // Don’t require ES features that PhantomJS doesn’t support | ||||
|                 // TODO: Toggle these settings now that we don't use PhantomJS | ||||
|                 "no-var": "off", | ||||
|                 "object-shorthand": "off", | ||||
|                 "prefer-arrow-callback": "off", | ||||
|             }, | ||||
|         }, | ||||
|         { | ||||
|             files: ["web/shared/**", "web/src/**", "web/third/**"], | ||||
|             env: { | ||||
|                 browser: true, | ||||
|                 node: false, | ||||
|             }, | ||||
|             globals: { | ||||
|                 DEVELOPMENT: false, | ||||
|                 ZULIP_VERSION: false, | ||||
|             }, | ||||
|             rules: { | ||||
|                 "no-console": "error", | ||||
|             }, | ||||
|             settings: { | ||||
|                 "import/resolver": { | ||||
|                     webpack: { | ||||
|                         config: "./web/webpack.config.ts", | ||||
|                     }, | ||||
|                 }, | ||||
|             }, | ||||
|         }, | ||||
|         { | ||||
|             files: ["web/shared/**"], | ||||
|             env: { | ||||
|                 browser: false, | ||||
|                 "shared-node-browser": true, | ||||
|             }, | ||||
|             rules: { | ||||
|                 "import/no-restricted-paths": [ | ||||
|                     "error", | ||||
|                     { | ||||
|                         zones: [ | ||||
|                             { | ||||
|                                 target: "./web/shared", | ||||
|                                 from: ".", | ||||
|                                 except: ["./node_modules", "./web/shared"], | ||||
|                             }, | ||||
|                         ], | ||||
|                     }, | ||||
|                 ], | ||||
|                 "unicorn/prefer-string-replace-all": "off", | ||||
|             }, | ||||
|         }, | ||||
|         { | ||||
|             files: ["web/server/**"], | ||||
|             env: { | ||||
|                 node: true, | ||||
|             }, | ||||
|         }, | ||||
|     ], | ||||
| }; | ||||
							
								
								
									
										230
									
								
								.eslintrc.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										230
									
								
								.eslintrc.json
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,230 @@ | ||||
| { | ||||
|     "env": { | ||||
|         "es2020": true, | ||||
|         "node": true | ||||
|     }, | ||||
|     "extends": [ | ||||
|         "eslint:recommended", | ||||
|         "plugin:import/errors", | ||||
|         "plugin:import/warnings", | ||||
|         "plugin:unicorn/recommended", | ||||
|         "prettier" | ||||
|     ], | ||||
|     "parser": "@babel/eslint-parser", | ||||
|     "parserOptions": { | ||||
|         "warnOnUnsupportedTypeScriptVersion": false, | ||||
|         "sourceType": "unambiguous" | ||||
|     }, | ||||
|     "reportUnusedDisableDirectives": true, | ||||
|     "rules": { | ||||
|         "array-callback-return": "error", | ||||
|         "arrow-body-style": "error", | ||||
|         "block-scoped-var": "error", | ||||
|         "consistent-return": "error", | ||||
|         "curly": "error", | ||||
|         "dot-notation": "error", | ||||
|         "eqeqeq": "error", | ||||
|         "guard-for-in": "error", | ||||
|         "import/extensions": "error", | ||||
|         "import/first": "error", | ||||
|         "import/newline-after-import": "error", | ||||
|         "import/no-useless-path-segments": "error", | ||||
|         "import/order": [ | ||||
|             "error", | ||||
|             { | ||||
|                 "alphabetize": {"order": "asc"}, | ||||
|                 "newlines-between": "always" | ||||
|             } | ||||
|         ], | ||||
|         "import/unambiguous": "error", | ||||
|         "lines-around-directive": "error", | ||||
|         "new-cap": "error", | ||||
|         "no-alert": "error", | ||||
|         "no-array-constructor": "error", | ||||
|         "no-bitwise": "error", | ||||
|         "no-caller": "error", | ||||
|         "no-catch-shadow": "error", | ||||
|         "no-constant-condition": ["error", {"checkLoops": false}], | ||||
|         "no-div-regex": "error", | ||||
|         "no-duplicate-imports": "error", | ||||
|         "no-else-return": "error", | ||||
|         "no-eq-null": "error", | ||||
|         "no-eval": "error", | ||||
|         "no-implicit-coercion": "error", | ||||
|         "no-implied-eval": "error", | ||||
|         "no-inner-declarations": "off", | ||||
|         "no-iterator": "error", | ||||
|         "no-label-var": "error", | ||||
|         "no-labels": "error", | ||||
|         "no-loop-func": "error", | ||||
|         "no-multi-str": "error", | ||||
|         "no-native-reassign": "error", | ||||
|         "no-new-func": "error", | ||||
|         "no-new-object": "error", | ||||
|         "no-new-wrappers": "error", | ||||
|         "no-octal-escape": "error", | ||||
|         "no-plusplus": "error", | ||||
|         "no-proto": "error", | ||||
|         "no-return-assign": "error", | ||||
|         "no-script-url": "error", | ||||
|         "no-self-compare": "error", | ||||
|         "no-sync": "error", | ||||
|         "no-throw-literal": "error", | ||||
|         "no-undef-init": "error", | ||||
|         "no-unneeded-ternary": ["error", {"defaultAssignment": false}], | ||||
|         "no-unused-expressions": "error", | ||||
|         "no-use-before-define": ["error", {"functions": false}], | ||||
|         "no-useless-concat": "error", | ||||
|         "no-useless-constructor": "error", | ||||
|         "no-var": "error", | ||||
|         "object-shorthand": "error", | ||||
|         "one-var": ["error", "never"], | ||||
|         "prefer-arrow-callback": "error", | ||||
|         "prefer-const": [ | ||||
|             "error", | ||||
|             { | ||||
|                 "ignoreReadBeforeAssign": true | ||||
|             } | ||||
|         ], | ||||
|         "radix": "error", | ||||
|         "sort-imports": ["error", {"ignoreDeclarationSort": true}], | ||||
|         "spaced-comment": ["error", "always", {"markers": ["/"]}], | ||||
|         "strict": "error", | ||||
|         "unicorn/consistent-function-scoping": "off", | ||||
|         "unicorn/explicit-length-check": "off", | ||||
|         "unicorn/filename-case": "off", | ||||
|         "unicorn/no-nested-ternary": "off", | ||||
|         "unicorn/no-null": "off", | ||||
|         "unicorn/no-process-exit": "off", | ||||
|         "unicorn/no-useless-undefined": "off", | ||||
|         "unicorn/number-literal-case": "off", | ||||
|         "unicorn/numeric-separators-style": "off", | ||||
|         "unicorn/prefer-module": "off", | ||||
|         "unicorn/prefer-node-protocol": "off", | ||||
|         "unicorn/prefer-spread": "off", | ||||
|         "unicorn/prefer-ternary": "off", | ||||
|         "unicorn/prevent-abbreviations": "off", | ||||
|         "valid-typeof": ["error", {"requireStringLiterals": true}], | ||||
|         "yoda": "error" | ||||
|     }, | ||||
|     "overrides": [ | ||||
|         { | ||||
|             "files": ["frontend_tests/puppeteer_lib/**", "frontend_tests/puppeteer_tests/**"], | ||||
|             "globals": { | ||||
|                 "$": false, | ||||
|                 "zulip_test": false | ||||
|             } | ||||
|         }, | ||||
|         { | ||||
|             "files": ["static/js/**"], | ||||
|             "globals": { | ||||
|                 "StripeCheckout": false | ||||
|             } | ||||
|         }, | ||||
|         { | ||||
|             "files": ["**/*.ts"], | ||||
|             "extends": ["plugin:@typescript-eslint/recommended", "plugin:import/typescript"], | ||||
|             "parserOptions": { | ||||
|                 "project": "tsconfig.json" | ||||
|             }, | ||||
|             "rules": { | ||||
|                 // Disable base rule to avoid conflict | ||||
|                 "no-duplicate-imports": "off", | ||||
|                 "no-unused-vars": "off", | ||||
|                 "no-useless-constructor": "off", | ||||
|  | ||||
|                 "@typescript-eslint/array-type": "error", | ||||
|                 "@typescript-eslint/await-thenable": "error", | ||||
|                 "@typescript-eslint/consistent-type-assertions": "error", | ||||
|                 "@typescript-eslint/consistent-type-imports": "error", | ||||
|                 "@typescript-eslint/explicit-function-return-type": [ | ||||
|                     "error", | ||||
|                     {"allowExpressions": true} | ||||
|                 ], | ||||
|                 "@typescript-eslint/member-ordering": "error", | ||||
|                 "@typescript-eslint/no-duplicate-imports": "off", | ||||
|                 "@typescript-eslint/no-explicit-any": "off", | ||||
|                 "@typescript-eslint/no-extraneous-class": "error", | ||||
|                 "@typescript-eslint/no-non-null-assertion": "off", | ||||
|                 "@typescript-eslint/no-parameter-properties": "error", | ||||
|                 "@typescript-eslint/no-unnecessary-qualifier": "error", | ||||
|                 "@typescript-eslint/no-unnecessary-type-assertion": "error", | ||||
|                 "@typescript-eslint/no-unused-vars": ["error", {"varsIgnorePattern": "^_"}], | ||||
|                 "@typescript-eslint/no-use-before-define": "error", | ||||
|                 "@typescript-eslint/no-useless-constructor": "error", | ||||
|                 "@typescript-eslint/prefer-includes": "error", | ||||
|                 "@typescript-eslint/prefer-regexp-exec": "error", | ||||
|                 "@typescript-eslint/prefer-string-starts-ends-with": "error", | ||||
|                 "@typescript-eslint/promise-function-async": "error", | ||||
|                 "@typescript-eslint/unified-signatures": "error", | ||||
|                 "no-undef": "error" | ||||
|             } | ||||
|         }, | ||||
|         { | ||||
|             "files": ["**/*.d.ts"], | ||||
|             "rules": { | ||||
|                 "import/unambiguous": "off" | ||||
|             } | ||||
|         }, | ||||
|         { | ||||
|             "files": ["frontend_tests/**"], | ||||
|             "globals": { | ||||
|                 "CSS": false, | ||||
|                 "document": false, | ||||
|                 "navigator": false, | ||||
|                 "window": false | ||||
|             }, | ||||
|             "rules": { | ||||
|                 "no-sync": "off" | ||||
|             } | ||||
|         }, | ||||
|         { | ||||
|             "files": ["tools/debug-require.js"], | ||||
|             "env": { | ||||
|                 "browser": true, | ||||
|                 "es2020": false | ||||
|             }, | ||||
|             "rules": { | ||||
|                 // Don’t require ES features that PhantomJS doesn’t support | ||||
|                 // TODO: Toggle these settings now that we don't use PhantomJS | ||||
|                 "no-var": "off", | ||||
|                 "object-shorthand": "off", | ||||
|                 "prefer-arrow-callback": "off" | ||||
|             } | ||||
|         }, | ||||
|         { | ||||
|             "files": ["static/**"], | ||||
|             "env": { | ||||
|                 "browser": true, | ||||
|                 "node": false | ||||
|             }, | ||||
|             "rules": { | ||||
|                 "no-console": "error" | ||||
|             }, | ||||
|             "settings": { | ||||
|                 "import/resolver": "webpack" | ||||
|             } | ||||
|         }, | ||||
|         { | ||||
|             "files": ["static/shared/**"], | ||||
|             "env": { | ||||
|                 "browser": false, | ||||
|                 "shared-node-browser": true | ||||
|             }, | ||||
|             "rules": { | ||||
|                 "import/no-restricted-paths": [ | ||||
|                     "error", | ||||
|                     { | ||||
|                         "zones": [ | ||||
|                             { | ||||
|                                 "target": "./static/shared", | ||||
|                                 "from": ".", | ||||
|                                 "except": ["./node_modules", "./static/shared"] | ||||
|                             } | ||||
|                         ] | ||||
|                     } | ||||
|                 ] | ||||
|             } | ||||
|         } | ||||
|     ] | ||||
| } | ||||
							
								
								
									
										19
									
								
								.gitattributes
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										19
									
								
								.gitattributes
									
									
									
									
										vendored
									
									
								
							| @@ -1,19 +1,4 @@ | ||||
| # DIFFS: Noise suppression. | ||||
| # | ||||
| # Suppress noisy generated files in diffs. | ||||
| # (When you actually want to see these diffs, use `git diff -a`.) | ||||
|  | ||||
| # Large test fixtures: | ||||
| corporate/tests/stripe_fixtures/*.json -diff | ||||
|  | ||||
|  | ||||
| # FORMATTING | ||||
|  | ||||
| # Maintain LF (Unix-style) newlines in text files. | ||||
| *   text=auto eol=lf | ||||
|  | ||||
| # Make sure various media files never get somehow auto-detected as text | ||||
| # and then newline-converted. | ||||
| *.gif binary | ||||
| *.jpg binary | ||||
| *.jpeg binary | ||||
| @@ -26,7 +11,3 @@ corporate/tests/stripe_fixtures/*.json -diff | ||||
| *.otf binary | ||||
| *.tif binary | ||||
| *.ogg binary | ||||
| *.bson binary | ||||
| *.bmp binary | ||||
| *.mp3 binary | ||||
| *.pdf binary | ||||
|   | ||||
							
								
								
									
										10
									
								
								.github/ISSUE_TEMPLATE/1_discussed_on_czo.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										10
									
								
								.github/ISSUE_TEMPLATE/1_discussed_on_czo.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,10 +0,0 @@ | ||||
| --- | ||||
| name: Issue discussed in the Zulip development community | ||||
| about: Bug report, feature or improvement already discussed on chat.zulip.org. | ||||
| --- | ||||
|  | ||||
| <!-- Issue description --> | ||||
|  | ||||
| <!-- Link to a message in the chat.zulip.org discussion. Message links will still work even if the topic is renamed or resolved. Link back to this issue from the chat.zulip.org thread. --> | ||||
|  | ||||
| CZO thread | ||||
							
								
								
									
										18
									
								
								.github/ISSUE_TEMPLATE/2_bug_report.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										18
									
								
								.github/ISSUE_TEMPLATE/2_bug_report.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,18 +0,0 @@ | ||||
| --- | ||||
| name: Bug report | ||||
| about: A concrete bug report with steps to reproduce the behavior. (See also "Possible bug" below.) | ||||
| labels: ["bug"] | ||||
| --- | ||||
|  | ||||
| <!-- Describe what you were expecting to see, what you saw instead, and steps to take in order to reproduce the buggy behavior. Screenshots can be helpful. --> | ||||
|  | ||||
| <!-- Check the box for the version of Zulip you are using (see https://zulip.com/help/view-zulip-version).--> | ||||
|  | ||||
| **Zulip Server and web app version:** | ||||
|  | ||||
| - [ ] Zulip Cloud (`*.zulipchat.com`) | ||||
| - [ ] Zulip Server 8.0+ | ||||
| - [ ] Zulip Server 7.0+ | ||||
| - [ ] Zulip Server 6.0+ | ||||
| - [ ] Zulip Server 5.0 or older | ||||
| - [ ] Other or not sure | ||||
							
								
								
									
										6
									
								
								.github/ISSUE_TEMPLATE/3_feature_request.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										6
									
								
								.github/ISSUE_TEMPLATE/3_feature_request.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,6 +0,0 @@ | ||||
| --- | ||||
| name: Feature or improvement request | ||||
| about: A specific proposal for a new feature of improvement. (See also "Feature suggestion or feedback" below.) | ||||
| --- | ||||
|  | ||||
| <!-- Describe the proposal, including how it would help you or your organization. --> | ||||
							
								
								
									
										14
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										14
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
								
							| @@ -1,14 +0,0 @@ | ||||
| blank_issues_enabled: true | ||||
| contact_links: | ||||
|   - name: Possible bug | ||||
|     url: https://zulip.readthedocs.io/en/latest/contributing/reporting-bugs.html | ||||
|     about: Report unexpected behavior that may be a bug. | ||||
|   - name: Feature suggestion or feedback | ||||
|     url: https://zulip.readthedocs.io/en/latest/contributing/suggesting-features.html | ||||
|     about: Start a discussion about your idea for improving Zulip. | ||||
|   - name: Issue with running or upgrading a Zulip server | ||||
|     url: https://zulip.readthedocs.io/en/latest/production/troubleshooting.html | ||||
|     about: We provide free, interactive support for the vast majority of questions about running a Zulip server. | ||||
|   - name: Other support requests and sales questions | ||||
|     url: https://zulip.com/help/contact-support | ||||
|     about: Contact us — we're happy to help! | ||||
							
								
								
									
										46
									
								
								.github/pull_request_template.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										46
									
								
								.github/pull_request_template.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,43 +1,11 @@ | ||||
| <!-- Describe your pull request here.--> | ||||
| <!-- What's this PR for?  (Just a link to an issue is fine.) --> | ||||
|  | ||||
| Fixes: <!-- Issue link, or clear description.--> | ||||
| **Testing plan:** <!-- How have you tested? --> | ||||
|  | ||||
| <!-- If the PR makes UI changes, always include one or more still screenshots to demonstrate your changes. If it seems helpful, add a screen capture of the new functionality as well. | ||||
|  | ||||
| Tooling tips: https://zulip.readthedocs.io/en/latest/tutorials/screenshot-and-gif-software.html | ||||
| **GIFs or screenshots:** <!-- If a UI change.  See: | ||||
|   https://zulip.readthedocs.io/en/latest/tutorials/screenshot-and-gif-software.html | ||||
|   --> | ||||
|  | ||||
| **Screenshots and screen captures:** | ||||
|  | ||||
| <details> | ||||
| <summary>Self-review checklist</summary> | ||||
|  | ||||
| <!-- Prior to submitting a PR, follow our step-by-step guide to review your own code: | ||||
| https://zulip.readthedocs.io/en/latest/contributing/code-reviewing.html#how-to-review-code --> | ||||
|  | ||||
| <!-- Once you create the PR, check off all the steps below that you have completed. | ||||
| If any of these steps are not relevant or you have not completed, leave them unchecked.--> | ||||
|  | ||||
| - [ ] [Self-reviewed](https://zulip.readthedocs.io/en/latest/contributing/code-reviewing.html#how-to-review-code) the changes for clarity and maintainability | ||||
|       (variable names, code reuse, readability, etc.). | ||||
|  | ||||
| Communicate decisions, questions, and potential concerns. | ||||
|  | ||||
| - [ ] Explains differences from previous plans (e.g., issue description). | ||||
| - [ ] Highlights technical choices and bugs encountered. | ||||
| - [ ] Calls out remaining decisions and concerns. | ||||
| - [ ] Automated tests verify logic where appropriate. | ||||
|  | ||||
| Individual commits are ready for review (see [commit discipline](https://zulip.readthedocs.io/en/latest/contributing/commit-discipline.html)). | ||||
|  | ||||
| - [ ] Each commit is a coherent idea. | ||||
| - [ ] Commit message(s) explain reasoning and motivation for changes. | ||||
|  | ||||
| Completed manual review and testing of the following: | ||||
|  | ||||
| - [ ] Visual appearance of the changes. | ||||
| - [ ] Responsiveness and internationalization. | ||||
| - [ ] Strings and tooltips. | ||||
| - [ ] End-to-end functionality of buttons, interactions and flows. | ||||
| - [ ] Corner cases, error conditions, and easily imagined bugs. | ||||
| </details> | ||||
| <!-- Also be sure to make clear, coherent commits: | ||||
|   https://zulip.readthedocs.io/en/latest/contributing/version-control.html | ||||
|   --> | ||||
|   | ||||
							
								
								
									
										43
									
								
								.github/workflows/cancel-previous-runs.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										43
									
								
								.github/workflows/cancel-previous-runs.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,43 @@ | ||||
| name: Cancel previous runs | ||||
| on: [push, pull_request] | ||||
|  | ||||
| defaults: | ||||
|   run: | ||||
|     shell: bash | ||||
|  | ||||
| jobs: | ||||
|   cancel: | ||||
|     name: Cancel previous runs | ||||
|     runs-on: ubuntu-latest | ||||
|     timeout-minutes: 3 | ||||
|  | ||||
|     # Don't run this job for zulip/zulip pushes since we | ||||
|     # want to run those jobs. | ||||
|     if: ${{ github.event_name != 'push' || github.event.repository.full_name != 'zulip/zulip' }} | ||||
|  | ||||
|     steps: | ||||
|       # We get workflow IDs from GitHub API so we don't have to maintain | ||||
|       # a hard-coded list of IDs which need to be updated when a workflow | ||||
|       # is added or removed. And, workflow IDs are different for other forks | ||||
|       # so this is required. | ||||
|       - name: Get workflow IDs. | ||||
|         id: workflow_ids | ||||
|         continue-on-error: true # Don't fail this job on failure | ||||
|         env: | ||||
|           # This is in <owner>/<repo> format e.g. zulip/zulip | ||||
|           REPOSITORY: ${{ github.repository }} | ||||
|         run: | | ||||
|           workflow_api_url=https://api.github.com/repos/$REPOSITORY/actions/workflows | ||||
|           curl $workflow_api_url -o workflows.json | ||||
|  | ||||
|           script="const {workflows} = require('./workflows'); \ | ||||
|                   const ids = workflows.map(workflow => workflow.id); \ | ||||
|                   console.log(ids.join(','));" | ||||
|           ids=$(node -e "$script") | ||||
|           echo "::set-output name=ids::$ids" | ||||
|  | ||||
|       - uses: styfle/cancel-workflow-action@0.9.0 | ||||
|         continue-on-error: true # Don't fail this job on failure | ||||
|         with: | ||||
|           workflow_id: ${{ steps.workflow_ids.outputs.ids }} | ||||
|           access_token: ${{ github.token }} | ||||
							
								
								
									
										35
									
								
								.github/workflows/codeql-analysis.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										35
									
								
								.github/workflows/codeql-analysis.yml
									
									
									
									
										vendored
									
									
								
							| @@ -1,40 +1,31 @@ | ||||
| name: "Code scanning" | ||||
|  | ||||
| on: | ||||
|   push: | ||||
|     branches: ["*.x", chat.zulip.org, main] | ||||
|     tags: ["*"] | ||||
|   pull_request: | ||||
|     branches: ["*.x", chat.zulip.org, main] | ||||
|   workflow_dispatch: | ||||
|  | ||||
| concurrency: | ||||
|   group: "${{ github.workflow }}-${{ github.head_ref || github.run_id }}" | ||||
|   cancel-in-progress: true | ||||
|  | ||||
| permissions: | ||||
|   contents: read | ||||
| on: [push, pull_request] | ||||
|  | ||||
| jobs: | ||||
|   CodeQL: | ||||
|     permissions: | ||||
|       actions: read # for github/codeql-action/init to get workflow details | ||||
|       contents: read # for actions/checkout to fetch code | ||||
|       security-events: write # for github/codeql-action/analyze to upload SARIF results | ||||
|     if: ${{!github.event.repository.private}} | ||||
|     runs-on: ubuntu-latest | ||||
|  | ||||
|     steps: | ||||
|       - name: Check out repository | ||||
|         uses: actions/checkout@v4 | ||||
|         uses: actions/checkout@v2 | ||||
|         with: | ||||
|           # We must fetch at least the immediate parents so that if this is | ||||
|           # a pull request then we can check out the head. | ||||
|           fetch-depth: 2 | ||||
|  | ||||
|       # If this run was triggered by a pull request event, then check out | ||||
|       # the head of the pull request instead of the merge commit. | ||||
|       - run: git checkout HEAD^2 | ||||
|         if: ${{ github.event_name == 'pull_request' }} | ||||
|  | ||||
|       # Initializes the CodeQL tools for scanning. | ||||
|       - name: Initialize CodeQL | ||||
|         uses: github/codeql-action/init@v3 | ||||
|         uses: github/codeql-action/init@v1 | ||||
|  | ||||
|         # Override language selection by uncommenting this and choosing your languages | ||||
|         # with: | ||||
|         #   languages: go, javascript, csharp, python, cpp, java | ||||
|  | ||||
|       - name: Perform CodeQL Analysis | ||||
|         uses: github/codeql-action/analyze@v3 | ||||
|         uses: github/codeql-action/analyze@v1 | ||||
|   | ||||
							
								
								
									
										262
									
								
								.github/workflows/production-suite.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										262
									
								
								.github/workflows/production-suite.yml
									
									
									
									
										vendored
									
									
								
							| @@ -2,51 +2,43 @@ name: Zulip production suite | ||||
|  | ||||
| on: | ||||
|   push: | ||||
|     branches: ["*.x", chat.zulip.org, main] | ||||
|     tags: ["*"] | ||||
|   pull_request: | ||||
|     paths: | ||||
|       - .github/workflows/production-suite.yml | ||||
|       - "**/migrations/**" | ||||
|       - manage.py | ||||
|       - pnpm-lock.yaml | ||||
|       - puppet/** | ||||
|       - requirements/** | ||||
|       - scripts/** | ||||
|       - static/** | ||||
|       - tools/** | ||||
|       - web/babel.config.js | ||||
|       - web/postcss.config.js | ||||
|       - web/third/** | ||||
|       - web/webpack.config.ts | ||||
|       - zerver/worker/queue_processors.py | ||||
|       - zerver/lib/push_notifications.py | ||||
|       - zerver/decorator.py | ||||
|       - zproject/** | ||||
|   workflow_dispatch: | ||||
|  | ||||
| concurrency: | ||||
|   group: "${{ github.workflow }}-${{ github.head_ref || github.run_id }}" | ||||
|   cancel-in-progress: true | ||||
|       - yarn.lock | ||||
|       - .github/workflows/production-suite.yml | ||||
|   pull_request: | ||||
|     paths: | ||||
|       - "**/migrations/**" | ||||
|       - puppet/** | ||||
|       - requirements/** | ||||
|       - scripts/** | ||||
|       - static/** | ||||
|       - tools/** | ||||
|       - zproject/** | ||||
|       - yarn.lock | ||||
|       - .github/workflows/production-suite.yml | ||||
|  | ||||
| defaults: | ||||
|   run: | ||||
|     shell: bash | ||||
|  | ||||
| permissions: | ||||
|   contents: read | ||||
|  | ||||
| jobs: | ||||
|   production_build: | ||||
|     # This job builds a release tarball from the current commit, which | ||||
|     # will be used for all of the following install/upgrade tests. | ||||
|     name: Ubuntu 22.04 production build | ||||
|     name: Bionic production build | ||||
|     runs-on: ubuntu-latest | ||||
|  | ||||
|     # Docker images are built from 'tools/ci/Dockerfile'; the comments at | ||||
|     # the top explain how to build and upload these images. | ||||
|     # Ubuntu 22.04 ships with Python 3.10.12. | ||||
|     container: zulip/ci:jammy | ||||
|  | ||||
|     # This docker image was created by a generated Dockerfile at: | ||||
|     #   tools/ci/images/bionic/Dockerfile | ||||
|     # Bionic ships with Python 3.6. | ||||
|     container: zulip/ci:bionic | ||||
|     steps: | ||||
|       - name: Add required permissions | ||||
|         run: | | ||||
| @@ -64,66 +56,56 @@ jobs: | ||||
|           # cache action to work. It is owned by root currently. | ||||
|           sudo chmod -R 0777 /__w/_temp/ | ||||
|  | ||||
|       - uses: actions/checkout@v4 | ||||
|       - uses: actions/checkout@v2 | ||||
|  | ||||
|       - name: Create cache directories | ||||
|         run: | | ||||
|           dirs=(/srv/zulip-{venv,emoji}-cache) | ||||
|           dirs=(/srv/zulip-{npm,venv,emoji}-cache) | ||||
|           sudo mkdir -p "${dirs[@]}" | ||||
|           sudo chown -R github "${dirs[@]}" | ||||
|  | ||||
|       - name: Restore pnpm store | ||||
|         uses: actions/cache@v4 | ||||
|       - name: Restore node_modules cache | ||||
|         uses: actions/cache@v2 | ||||
|         with: | ||||
|           path: /__w/.pnpm-store | ||||
|           key: v1-pnpm-store-jammy-${{ hashFiles('pnpm-lock.yaml') }} | ||||
|           path: /srv/zulip-npm-cache | ||||
|           key: v1-yarn-deps-bionic-${{ hashFiles('package.json') }}-${{ hashFiles('yarn.lock') }} | ||||
|           restore-keys: v1-yarn-deps-bionic | ||||
|  | ||||
|       - name: Restore python cache | ||||
|         uses: actions/cache@v4 | ||||
|         uses: actions/cache@v2 | ||||
|         with: | ||||
|           path: /srv/zulip-venv-cache | ||||
|           key: v1-venv-jammy-${{ hashFiles('requirements/dev.txt') }} | ||||
|           restore-keys: v1-venv-jammy | ||||
|           key: v1-venv-bionic-${{ hashFiles('requirements/dev.txt') }} | ||||
|           restore-keys: v1-venv-bionic | ||||
|  | ||||
|       - name: Restore emoji cache | ||||
|         uses: actions/cache@v4 | ||||
|         uses: actions/cache@v2 | ||||
|         with: | ||||
|           path: /srv/zulip-emoji-cache | ||||
|           key: v1-emoji-jammy-${{ hashFiles('tools/setup/emoji/emoji_map.json') }}-${{ hashFiles('tools/setup/emoji/build_emoji') }}-${{ hashFiles('tools/setup/emoji/emoji_setup_utils.py') }}-${{ hashFiles('tools/setup/emoji/emoji_names.py') }}-${{ hashFiles('package.json') }} | ||||
|           restore-keys: v1-emoji-jammy | ||||
|           key: v1-emoji-bionic-${{ hashFiles('tools/setup/emoji/emoji_map.json') }}-${{ hashFiles('tools/setup/emoji/build_emoji') }}-${{ hashFiles('tools/setup/emoji/emoji_setup_utils.py') }}-${{ hashFiles('tools/setup/emoji/emoji_names.py') }}-${{ hashFiles('package.json') }} | ||||
|           restore-keys: v1-emoji-bionic | ||||
|  | ||||
|       - name: Do Bionic hack | ||||
|         run: | | ||||
|           # Temporary hack till `sudo service redis-server start` gets fixes in Bionic. See | ||||
|           # https://chat.zulip.org/#narrow/stream/3-backend/topic/Ubuntu.20bionic.20CircleCI | ||||
|           sudo sed -i '/^bind/s/bind.*/bind 0.0.0.0/' /etc/redis/redis.conf | ||||
|  | ||||
|       - name: Build production tarball | ||||
|         run: ./tools/ci/production-build | ||||
|  | ||||
|       - name: Upload production build artifacts for install jobs | ||||
|         uses: actions/upload-artifact@v4 | ||||
|         uses: actions/upload-artifact@v2 | ||||
|         with: | ||||
|           name: production-tarball | ||||
|           path: /tmp/production-build | ||||
|           retention-days: 1 | ||||
|           retention-days: 14 | ||||
|  | ||||
|       - name: Verify pnpm store path | ||||
|         run: | | ||||
|           set -x | ||||
|           path="$(pnpm store path)" | ||||
|           [[ "$path" == /__w/.pnpm-store/* ]] | ||||
|  | ||||
|       - name: Generate failure report string | ||||
|         id: failure_report_string | ||||
|         if: ${{ failure() && github.repository == 'zulip/zulip' && github.event_name == 'push' }} | ||||
|         run: tools/ci/generate-failure-message >> $GITHUB_OUTPUT | ||||
|  | ||||
|       - name: Report status to CZO | ||||
|         if: ${{ failure() && github.repository == 'zulip/zulip' && github.event_name == 'push' }} | ||||
|         uses: zulip/github-actions-zulip/send-message@v1 | ||||
|         with: | ||||
|           api-key: ${{ secrets.ZULIP_BOT_KEY }} | ||||
|           email: "github-actions-bot@chat.zulip.org" | ||||
|           organization-url: "https://chat.zulip.org" | ||||
|           to: "automated testing" | ||||
|           topic: ${{ steps.failure_report_string.outputs.topic }} | ||||
|           type: "stream" | ||||
|           content: ${{ steps.failure_report_string.outputs.content }} | ||||
|       - name: Report status | ||||
|         if: failure() | ||||
|         env: | ||||
|           ZULIP_BOT_KEY: ${{ secrets.ZULIP_BOT_KEY }} | ||||
|         run: tools/ci/send-failure-message | ||||
|  | ||||
|   production_install: | ||||
|     # This job installs the server release tarball built above on a | ||||
| @@ -133,22 +115,27 @@ jobs: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         include: | ||||
|           # Docker images are built from 'tools/ci/Dockerfile'; the comments at | ||||
|           # the top explain how to build and upload these images. | ||||
|           - docker_image: zulip/ci:jammy | ||||
|             name: Ubuntu 22.04 production install and PostgreSQL upgrade with pgroonga | ||||
|             os: jammy | ||||
|             extra-args: "" | ||||
|           # Base images are built using `tools/ci/Dockerfile.template`. | ||||
|           # The comments at the top explain how to build and upload these images. | ||||
|           - docker_image: zulip/ci:bionic | ||||
|             name: Bionic production install | ||||
|             is_bionic: true | ||||
|             os: bionic | ||||
|  | ||||
|           - docker_image: zulip/ci:noble | ||||
|             name: Ubuntu 24.04 production install | ||||
|             os: noble | ||||
|             extra-args: "" | ||||
|           - docker_image: zulip/ci:focal | ||||
|             name: Focal production install | ||||
|             is_focal: true | ||||
|             os: focal | ||||
|  | ||||
|           - docker_image: zulip/ci:bookworm | ||||
|             name: Debian 12 production install with custom db name and user | ||||
|             os: bookworm | ||||
|             extra-args: --test-custom-db | ||||
|           - docker_image: zulip/ci:buster | ||||
|             name: Buster production install | ||||
|             is_buster: true | ||||
|             os: buster | ||||
|  | ||||
|           - docker_image: zulip/ci:bullseye | ||||
|             name: Bullseye production install | ||||
|             is_bullseye: true | ||||
|             os: bullseye | ||||
|  | ||||
|     name: ${{ matrix.name  }} | ||||
|     container: | ||||
| @@ -159,7 +146,7 @@ jobs: | ||||
|  | ||||
|     steps: | ||||
|       - name: Download built production tarball | ||||
|         uses: actions/download-artifact@v4 | ||||
|         uses: actions/download-artifact@v2 | ||||
|         with: | ||||
|           name: production-tarball | ||||
|           path: /tmp | ||||
| @@ -171,58 +158,61 @@ jobs: | ||||
|           # cache action to work. It is owned by root currently. | ||||
|           sudo chmod -R 0777 /__w/_temp/ | ||||
|  | ||||
|           # Since actions/download-artifact@v4 loses all the permissions | ||||
|           # Create the zulip directory that the tools/ci/ scripts needs | ||||
|           mkdir -p /home/github/zulip | ||||
|  | ||||
|           # Since actions/download-artifact@v2 loses all the permissions | ||||
|           # of the tarball uploaded by the upload artifact fix those. | ||||
|           chmod +x /tmp/production-extract-tarball | ||||
|           chmod +x /tmp/production-upgrade-pg | ||||
|           chmod +x /tmp/production-pgroonga | ||||
|           chmod +x /tmp/production-install | ||||
|           chmod +x /tmp/production-verify | ||||
|           chmod +x /tmp/generate-failure-message | ||||
|           chmod +x /tmp/send-failure-message | ||||
|  | ||||
|       - name: Create cache directories | ||||
|         run: | | ||||
|           dirs=(/srv/zulip-{venv,emoji}-cache) | ||||
|           dirs=(/srv/zulip-{npm,venv,emoji}-cache) | ||||
|           sudo mkdir -p "${dirs[@]}" | ||||
|           sudo chown -R github "${dirs[@]}" | ||||
|  | ||||
|       - name: Restore node_modules cache | ||||
|         uses: actions/cache@v2 | ||||
|         with: | ||||
|           path: /srv/zulip-npm-cache | ||||
|           key: v1-yarn-deps-${{ matrix.os }}-${{ hashFiles('/tmp/package.json') }}-${{ hashFiles('/tmp/yarn.lock') }} | ||||
|           restore-keys: v1-yarn-deps-${{ matrix.os }} | ||||
|  | ||||
|       - name: Do Bionic hack | ||||
|         if: ${{ matrix.is_bionic }} | ||||
|         run: | | ||||
|           # Temporary hack till `sudo service redis-server start` gets fixes in Bionic. See | ||||
|           # https://chat.zulip.org/#narrow/stream/3-backend/topic/Ubuntu.20bionic.20CircleCI | ||||
|           sudo sed -i '/^bind/s/bind.*/bind 0.0.0.0/' /etc/redis/redis.conf | ||||
|  | ||||
|       - name: Production extract tarball | ||||
|         run: /tmp/production-extract-tarball | ||||
|  | ||||
|       - name: Install production | ||||
|         run: sudo /tmp/production-install ${{ matrix.extra-args }} | ||||
|         run: | | ||||
|           sudo service rabbitmq-server restart | ||||
|           sudo /tmp/production-install | ||||
|  | ||||
|       - name: Verify install | ||||
|         run: sudo /tmp/production-verify ${{ matrix.extra-args }} | ||||
|  | ||||
|       - name: Install pgroonga | ||||
|         if: ${{ matrix.os == 'jammy' }} | ||||
|         run: sudo /tmp/production-pgroonga | ||||
|  | ||||
|       - name: Verify install after installing pgroonga | ||||
|         if: ${{ matrix.os == 'jammy' }} | ||||
|         run: sudo /tmp/production-verify ${{ matrix.extra-args }} | ||||
|         run: sudo /tmp/production-verify | ||||
|  | ||||
|       - name: Upgrade postgresql | ||||
|         if: ${{ matrix.os == 'jammy' }} | ||||
|         if: ${{ matrix.is_bionic }} | ||||
|         run: sudo /tmp/production-upgrade-pg | ||||
|  | ||||
|       - name: Verify install after upgrading postgresql | ||||
|         if: ${{ matrix.os == 'jammy' }} | ||||
|         run: sudo /tmp/production-verify ${{ matrix.extra-args }} | ||||
|         if: ${{ matrix.is_bionic }} | ||||
|         run: sudo /tmp/production-verify | ||||
|  | ||||
|       - name: Generate failure report string | ||||
|         id: failure_report_string | ||||
|         if: ${{ failure() && github.repository == 'zulip/zulip' && github.event_name == 'push' }} | ||||
|         run: /tmp/generate-failure-message >> $GITHUB_OUTPUT | ||||
|  | ||||
|       - name: Report status to CZO | ||||
|         if: ${{ failure() && github.repository == 'zulip/zulip' && github.event_name == 'push' }} | ||||
|         uses: zulip/github-actions-zulip/send-message@v1 | ||||
|         with: | ||||
|           api-key: ${{ secrets.ZULIP_BOT_KEY }} | ||||
|           email: "github-actions-bot@chat.zulip.org" | ||||
|           organization-url: "https://chat.zulip.org" | ||||
|           to: "automated testing" | ||||
|           topic: ${{ steps.failure_report_string.outputs.topic }} | ||||
|           type: "stream" | ||||
|           content: ${{ steps.failure_report_string.outputs.content }} | ||||
|       - name: Report status | ||||
|         if: failure() | ||||
|         env: | ||||
|           ZULIP_BOT_KEY: ${{ secrets.ZULIP_BOT_KEY }} | ||||
|         run: /tmp/send-failure-message | ||||
|  | ||||
|   production_upgrade: | ||||
|     # The production upgrade job starts with a container with a | ||||
| @@ -235,17 +225,12 @@ jobs: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         include: | ||||
|           # Docker images are built from 'tools/ci/Dockerfile.prod'; the comments at | ||||
|           # the top explain how to build and upload these images. | ||||
|           - docker_image: zulip/ci:jammy-6.0 | ||||
|             name: 6.0 Version Upgrade | ||||
|             os: jammy | ||||
|           - docker_image: zulip/ci:bookworm-7.0 | ||||
|             name: 7.0 Version Upgrade | ||||
|             os: bookworm | ||||
|           - docker_image: zulip/ci:bookworm-8.0 | ||||
|             name: 8.0 Version Upgrade | ||||
|             os: bookworm | ||||
|           # Base images are built using `tools/ci/Dockerfile.prod.template`. | ||||
|           # The comments at the top explain how to build and upload these images. | ||||
|           - docker_image: zulip/ci:buster-3.4 | ||||
|             name: 3.4 Version Upgrade | ||||
|             is_focal: true | ||||
|             os: buster | ||||
|  | ||||
|     name: ${{ matrix.name  }} | ||||
|     container: | ||||
| @@ -256,7 +241,7 @@ jobs: | ||||
|  | ||||
|     steps: | ||||
|       - name: Download built production tarball | ||||
|         uses: actions/download-artifact@v4 | ||||
|         uses: actions/download-artifact@v2 | ||||
|         with: | ||||
|           name: production-tarball | ||||
|           path: /tmp | ||||
| @@ -268,17 +253,11 @@ jobs: | ||||
|           # cache action to work. It is owned by root currently. | ||||
|           sudo chmod -R 0777 /__w/_temp/ | ||||
|  | ||||
|           # Since actions/download-artifact@v4 loses all the permissions | ||||
|           # Since actions/download-artifact@v2 loses all the permissions | ||||
|           # of the tarball uploaded by the upload artifact fix those. | ||||
|           chmod +x /tmp/production-upgrade | ||||
|           chmod +x /tmp/production-verify | ||||
|           chmod +x /tmp/generate-failure-message | ||||
|  | ||||
|       - name: Create cache directories | ||||
|         run: | | ||||
|           dirs=(/srv/zulip-{venv,emoji}-cache) | ||||
|           sudo mkdir -p "${dirs[@]}" | ||||
|           sudo chown -R github "${dirs[@]}" | ||||
|           chmod +x /tmp/send-failure-message | ||||
|  | ||||
|       - name: Upgrade production | ||||
|         run: sudo /tmp/production-upgrade | ||||
| @@ -289,19 +268,8 @@ jobs: | ||||
|         # - name: Verify install | ||||
|         #   run: sudo /tmp/production-verify | ||||
|  | ||||
|       - name: Generate failure report string | ||||
|         id: failure_report_string | ||||
|         if: ${{ failure() && github.repository == 'zulip/zulip' && github.event_name == 'push' }} | ||||
|         run: /tmp/generate-failure-message >> $GITHUB_OUTPUT | ||||
|  | ||||
|       - name: Report status to CZO | ||||
|         if: ${{ failure() && github.repository == 'zulip/zulip' && github.event_name == 'push' }} | ||||
|         uses: zulip/github-actions-zulip/send-message@v1 | ||||
|         with: | ||||
|           api-key: ${{ secrets.ZULIP_BOT_KEY }} | ||||
|           email: "github-actions-bot@chat.zulip.org" | ||||
|           organization-url: "https://chat.zulip.org" | ||||
|           to: "automated testing" | ||||
|           topic: ${{ steps.failure_report_string.outputs.topic }} | ||||
|           type: "stream" | ||||
|           content: ${{ steps.failure_report_string.outputs.content }} | ||||
|       - name: Report status | ||||
|         if: failure() | ||||
|         env: | ||||
|           ZULIP_BOT_KEY: ${{ secrets.ZULIP_BOT_KEY }} | ||||
|         run: /tmp/send-failure-message | ||||
|   | ||||
							
								
								
									
										7
									
								
								.github/workflows/update-oneclick-apps.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										7
									
								
								.github/workflows/update-oneclick-apps.yml
									
									
									
									
										vendored
									
									
								
							| @@ -2,14 +2,11 @@ name: Update one click apps | ||||
| on: | ||||
|   release: | ||||
|     types: [published] | ||||
| permissions: | ||||
|   contents: read | ||||
|  | ||||
| jobs: | ||||
|   update-digitalocean-oneclick-app: | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|       - uses: actions/checkout@v4 | ||||
|       - uses: actions/checkout@v2 | ||||
|       - name: Update DigitalOcean one click app | ||||
|         env: | ||||
|           DIGITALOCEAN_API_KEY: ${{ secrets.ONE_CLICK_ACTION_DIGITALOCEAN_API_KEY }} | ||||
| @@ -22,6 +19,6 @@ jobs: | ||||
|         run: | | ||||
|           export PATH="$HOME/.local/bin:$PATH" | ||||
|           git clone https://github.com/zulip/marketplace-partners | ||||
|           pip3 install python-digitalocean zulip fab-classic PyNaCl | ||||
|           pip3 install python-digitalocean zulip fab-classic | ||||
|           echo $PATH | ||||
|           python3 tools/oneclickapps/prepare_digital_ocean_one_click_app_release.py | ||||
|   | ||||
							
								
								
									
										252
									
								
								.github/workflows/zulip-ci.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										252
									
								
								.github/workflows/zulip-ci.yml
									
									
									
									
										vendored
									
									
								
							| @@ -4,49 +4,43 @@ | ||||
|  | ||||
| name: Zulip CI | ||||
|  | ||||
| on: | ||||
|   push: | ||||
|     branches: ["*.x", chat.zulip.org, main] | ||||
|     tags: ["*"] | ||||
|   pull_request: | ||||
|   workflow_dispatch: | ||||
|  | ||||
| concurrency: | ||||
|   group: "${{ github.workflow }}-${{ github.head_ref || github.run_id }}" | ||||
|   cancel-in-progress: true | ||||
| on: [push, pull_request] | ||||
|  | ||||
| defaults: | ||||
|   run: | ||||
|     shell: bash | ||||
|  | ||||
| permissions: | ||||
|   contents: read | ||||
|  | ||||
| jobs: | ||||
|   tests: | ||||
|     strategy: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         include: | ||||
|           # Base images are built using `tools/ci/Dockerfile.prod.template`. | ||||
|           # The comments at the top explain how to build and upload these images. | ||||
|           # Ubuntu 22.04 ships with Python 3.10.12. | ||||
|           - docker_image: zulip/ci:jammy | ||||
|             name: Ubuntu 22.04 (Python 3.10, backend + frontend) | ||||
|             os: jammy | ||||
|             include_documentation_tests: false | ||||
|           # This docker image was created by a generated Dockerfile at: | ||||
|           #   tools/ci/images/bionic/Dockerfile | ||||
|           # Bionic ships with Python 3.6. | ||||
|           - docker_image: zulip/ci:bionic | ||||
|             name: Ubuntu 18.04 Bionic (Python 3.6, backend + frontend) | ||||
|             os: bionic | ||||
|             is_bionic: true | ||||
|             include_frontend_tests: true | ||||
|           # Debian 12 ships with Python 3.11.2. | ||||
|           - docker_image: zulip/ci:bookworm | ||||
|             name: Debian 12 (Python 3.11, backend + documentation) | ||||
|             os: bookworm | ||||
|             include_documentation_tests: true | ||||
|  | ||||
|           # This docker image was created by a generated Dockerfile at: | ||||
|           #   tools/ci/images/focal/Dockerfile | ||||
|           # Focal ships with Python 3.8.2. | ||||
|           - docker_image: zulip/ci:focal | ||||
|             name: Ubuntu 20.04 Focal (Python 3.8, backend) | ||||
|             os: focal | ||||
|             is_focal: true | ||||
|             include_frontend_tests: false | ||||
|           # Ubuntu 24.04 ships with Python 3.12.2. | ||||
|           - docker_image: zulip/ci:noble | ||||
|             name: Ubuntu 24.04 (Python 3.12, backend) | ||||
|             os: noble | ||||
|             include_documentation_tests: false | ||||
|  | ||||
|           # This docker image was created by a generated Dockerfile at: | ||||
|           #   tools/ci/images/focal/Dockerfile | ||||
|           # Bullseye ships with Python 3.9.2. | ||||
|           - docker_image: zulip/ci:bullseye | ||||
|             name: Debian 11 Bullseye (Python 3.9, backend) | ||||
|             os: bullseye | ||||
|             is_bullseye: true | ||||
|             include_frontend_tests: false | ||||
|  | ||||
|     runs-on: ubuntu-latest | ||||
| @@ -54,7 +48,7 @@ jobs: | ||||
|     container: ${{ matrix.docker_image }} | ||||
|     env: | ||||
|       # GitHub Actions sets HOME to /github/home which causes | ||||
|       # problem later in provision and frontend test that runs | ||||
|       # problem later in provison and frontend test that runs | ||||
|       # tools/setup/postgresql-init-dev-db because of the .pgpass | ||||
|       # location. PostgreSQL (psql) expects .pgpass to be at | ||||
|       # /home/github/.pgpass and setting home to `/home/github/` | ||||
| @@ -62,57 +56,115 @@ jobs: | ||||
|       HOME: /home/github/ | ||||
|  | ||||
|     steps: | ||||
|       - uses: actions/checkout@v4 | ||||
|       - name: Add required permissions | ||||
|         run: | | ||||
|           # The checkout actions doesn't clone to ~/zulip or allow | ||||
|           # us to use the path option to clone outside the current | ||||
|           # /__w/zulip/zulip directory. Since this directory is owned | ||||
|           # by root we need to change it's ownership to allow the | ||||
|           # github user to clone the code here. | ||||
|           # Note: /__w/ is a docker volume mounted to $GITHUB_WORKSPACE | ||||
|           # which is /home/runner/work/. | ||||
|           sudo chown -R github . | ||||
|  | ||||
|           # This is the GitHub Actions specific cache directory the | ||||
|           # the current github user must be able to access for the | ||||
|           # cache action to work. It is owned by root currently. | ||||
|           sudo chmod -R 0777 /__w/_temp/ | ||||
|  | ||||
|       - uses: actions/checkout@v2 | ||||
|  | ||||
|       - name: Create cache directories | ||||
|         run: | | ||||
|           dirs=(/srv/zulip-{venv,emoji}-cache) | ||||
|           dirs=(/srv/zulip-{npm,venv,emoji}-cache) | ||||
|           sudo mkdir -p "${dirs[@]}" | ||||
|           sudo chown -R github "${dirs[@]}" | ||||
|  | ||||
|       - name: Restore pnpm store | ||||
|         uses: actions/cache@v4 | ||||
|       - name: Restore node_modules cache | ||||
|         uses: actions/cache@v2 | ||||
|         with: | ||||
|           path: /__w/.pnpm-store | ||||
|           key: v1-pnpm-store-${{ matrix.os }}-${{ hashFiles('pnpm-lock.yaml') }} | ||||
|           path: /srv/zulip-npm-cache | ||||
|           key: v1-yarn-deps-${{ matrix.os }}-${{ hashFiles('package.json') }}-${{ hashFiles('yarn.lock') }} | ||||
|           restore-keys: v1-yarn-deps-${{ matrix.os }} | ||||
|  | ||||
|       - name: Restore python cache | ||||
|         uses: actions/cache@v4 | ||||
|         uses: actions/cache@v2 | ||||
|         with: | ||||
|           path: /srv/zulip-venv-cache | ||||
|           key: v1-venv-${{ matrix.os }}-${{ hashFiles('requirements/dev.txt') }} | ||||
|           restore-keys: v1-venv-${{ matrix.os }} | ||||
|  | ||||
|       - name: Restore emoji cache | ||||
|         uses: actions/cache@v4 | ||||
|         uses: actions/cache@v2 | ||||
|         with: | ||||
|           path: /srv/zulip-emoji-cache | ||||
|           key: v1-emoji-${{ matrix.os }}-${{ hashFiles('tools/setup/emoji/emoji_map.json', 'tools/setup/emoji/build_emoji', 'tools/setup/emoji/emoji_setup_utils.py', 'tools/setup/emoji/emoji_names.py', 'package.json') }} | ||||
|           key: v1-emoji-${{ matrix.os }}-${{ hashFiles('tools/setup/emoji/emoji_map.json') }}-${{ hashFiles('tools/setup/emoji/build_emoji') }}-${{ hashFiles('tools/setup/emoji/emoji_setup_utils.py') }}-${{ hashFiles('tools/setup/emoji/emoji_names.py') }}-${{ hashFiles('package.json') }} | ||||
|           restore-keys: v1-emoji-${{ matrix.os }} | ||||
|  | ||||
|       - name: Do Bionic hack | ||||
|         if: ${{ matrix.is_bionic }} | ||||
|         run: | | ||||
|           # Temporary hack till `sudo service redis-server start` gets fixes in Bionic. See | ||||
|           # https://chat.zulip.org/#narrow/stream/3-backend/topic/Ubuntu.20bionic.20CircleCI | ||||
|           sudo sed -i '/^bind/s/bind.*/bind 0.0.0.0/' /etc/redis/redis.conf | ||||
|  | ||||
|       - name: Install dependencies | ||||
|         run: | | ||||
|           # This is the main setup job for the test suite | ||||
|           ./tools/ci/setup-backend --skip-dev-db-build | ||||
|           scripts/lib/clean_unused_caches.py --verbose --threshold=0 | ||||
|  | ||||
|           # Cleaning caches is mostly unnecessary in GitHub Actions, because | ||||
|           # most builds don't get to write to the cache. | ||||
|           # scripts/lib/clean-unused-caches --verbose --threshold 0 | ||||
|  | ||||
|       - name: Run tools test | ||||
|         run: | | ||||
|           source tools/ci/activate-venv | ||||
|           ./tools/test-tools | ||||
|  | ||||
|       - name: Run Codespell lint | ||||
|       - name: Run backend lint | ||||
|         run: | | ||||
|           source tools/ci/activate-venv | ||||
|           ./tools/run-codespell | ||||
|           echo "Test suite is running under $(python --version)." | ||||
|           ./tools/lint --groups=backend --skip=gitlint,mypy # gitlint disabled because flaky | ||||
|  | ||||
|       - name: Run frontend lint | ||||
|         if: ${{ matrix.include_frontend_tests }} | ||||
|         run: | | ||||
|           source tools/ci/activate-venv | ||||
|           ./tools/lint --groups=frontend --skip=gitlint # gitlint disabled because flaky | ||||
|  | ||||
|       - name: Run backend tests | ||||
|         run: | | ||||
|           source tools/ci/activate-venv | ||||
|           ./tools/test-backend --coverage --include-webhooks --no-cov-cleanup --ban-console-output | ||||
|  | ||||
|       - name: Run mypy | ||||
|         run: | | ||||
|           source tools/ci/activate-venv | ||||
|           # We run mypy after the backend tests so we get output from the | ||||
|           # backend tests, which tend to uncover more serious problems, first. | ||||
|           ./tools/run-mypy --version | ||||
|           ./tools/run-mypy | ||||
|  | ||||
|       - name: Run miscellaneous tests | ||||
|         run: | | ||||
|           source tools/ci/activate-venv | ||||
|  | ||||
|           # Currently our compiled requirements files will differ for different python versions | ||||
|           # so we will run test-locked-requirements only for Bionic. | ||||
|           # ./tools/test-locked-requirements | ||||
|           # ./tools/test-run-dev  # https://github.com/zulip/zulip/pull/14233 | ||||
|           # | ||||
|           # This test has been persistently flaky at like 1% frequency, is slow, | ||||
|           # and is for a very specific single feature, so we don't run it by default: | ||||
|           # ./tools/test-queue-worker-reload | ||||
|  | ||||
|           ./tools/test-migrations | ||||
|           ./tools/setup/optimize-svg --check | ||||
|           ./tools/setup/generate_integration_bots_avatars.py --check-missing | ||||
|  | ||||
|       # We run the tests that are only run in a specific job early, so | ||||
|       # that we get feedback to the developer about likely failures as | ||||
|       # quickly as possible. Backend/mypy failures that aren't | ||||
|       # identical across different versions are much more rare than | ||||
|       # frontend linter or node test failures. | ||||
|       - name: Run documentation and api tests | ||||
|         if: ${{ matrix.include_documentation_tests }} | ||||
|         run: | | ||||
|           source tools/ci/activate-venv | ||||
|           # In CI, we only test links we control in test-documentation to avoid flakes | ||||
| @@ -125,13 +177,7 @@ jobs: | ||||
|         run: | | ||||
|           source tools/ci/activate-venv | ||||
|           # Run the node tests first, since they're fast and deterministic | ||||
|           ./tools/test-js-with-node --coverage --parallel=1 | ||||
|  | ||||
|       - name: Run frontend lint | ||||
|         if: ${{ matrix.include_frontend_tests }} | ||||
|         run: | | ||||
|           source tools/ci/activate-venv | ||||
|           ./tools/lint --groups=frontend --skip=gitlint # gitlint disabled because flaky | ||||
|           ./tools/test-js-with-node --coverage | ||||
|  | ||||
|       - name: Check schemas | ||||
|         if: ${{ matrix.include_frontend_tests }} | ||||
| @@ -154,55 +200,6 @@ jobs: | ||||
|           source tools/ci/activate-venv | ||||
|           ./tools/test-js-with-puppeteer | ||||
|  | ||||
|       - name: Check pnpm dedupe | ||||
|         if: ${{ matrix.include_frontend_tests }} | ||||
|         run: pnpm dedupe --check | ||||
|  | ||||
|       - name: Run backend lint | ||||
|         run: | | ||||
|           source tools/ci/activate-venv | ||||
|           echo "Test suite is running under $(python --version)." | ||||
|           ./tools/lint --groups=backend --skip=gitlint,mypy # gitlint disabled because flaky | ||||
|  | ||||
|       - name: Run backend tests | ||||
|         run: | | ||||
|           source tools/ci/activate-venv | ||||
|           ./tools/test-backend ${{ matrix.os != 'bookworm' && '--coverage' || '' }} --xml-report --no-html-report --include-webhooks --include-transaction-tests --no-cov-cleanup --ban-console-output | ||||
|  | ||||
|       - name: Run mypy | ||||
|         run: | | ||||
|           source tools/ci/activate-venv | ||||
|           # We run mypy after the backend tests so we get output from the | ||||
|           # backend tests, which tend to uncover more serious problems, first. | ||||
|           ./tools/run-mypy --version | ||||
|           ./tools/run-mypy | ||||
|  | ||||
|       - name: Run miscellaneous tests | ||||
|         run: | | ||||
|           source tools/ci/activate-venv | ||||
|  | ||||
|           # Currently our compiled requirements files will differ for different | ||||
|           # Python versions, so we will run test-locked-requirements only on the | ||||
|           # platform with the oldest one. | ||||
|           # ./tools/test-locked-requirements | ||||
|           # ./tools/test-run-dev  # https://github.com/zulip/zulip/pull/14233 | ||||
|           # | ||||
|           # This test has been persistently flaky at like 1% frequency, is slow, | ||||
|           # and is for a very specific single feature, so we don't run it by default: | ||||
|           # ./tools/test-queue-worker-reload | ||||
|  | ||||
|           ./tools/test-migrations | ||||
|           ./tools/setup/optimize-svg --check | ||||
|           ./tools/setup/generate_integration_bots_avatars.py --check-missing | ||||
|           ./tools/ci/check-executables | ||||
|  | ||||
|           # Ban check-database-compatibility from transitively | ||||
|           # relying on static/generated, because it might not be | ||||
|           # up-to-date at that point in upgrade-zulip-stage-2. | ||||
|           chmod 000 static/generated web/generated | ||||
|           ./scripts/lib/check-database-compatibility | ||||
|           chmod 755 static/generated web/generated | ||||
|  | ||||
|       - name: Check for untracked files | ||||
|         run: | | ||||
|           source tools/ci/activate-venv | ||||
| @@ -215,7 +212,7 @@ jobs: | ||||
|           fi | ||||
|  | ||||
|       - name: Test locked requirements | ||||
|         if: ${{ matrix.os == 'jammy' }} | ||||
|         if: ${{ matrix.is_bionic }} | ||||
|         run: | | ||||
|           . /srv/zulip-py3-venv/bin/activate && \ | ||||
|           ./tools/test-locked-requirements | ||||
| @@ -223,44 +220,31 @@ jobs: | ||||
|       - name: Upload coverage reports | ||||
|  | ||||
|         # Only upload coverage when both frontend and backend | ||||
|         # tests are run. | ||||
|         # tests are ran. | ||||
|         if: ${{ matrix.include_frontend_tests }} | ||||
|         uses: codecov/codecov-action@v4 | ||||
|         with: | ||||
|           files: var/coverage.xml,var/node-coverage/lcov.info | ||||
|           token: ${{ secrets.CODECOV_TOKEN }} | ||||
|         run: | | ||||
|           # Codcov requires `.coverage` file to be stored in the | ||||
|           # current working directory. | ||||
|           mv ./var/.coverage ./.coverage | ||||
|           . /srv/zulip-py3-venv/bin/activate || true | ||||
|  | ||||
|           pip install codecov && codecov || echo "Error in uploading coverage reports to codecov.io." | ||||
|  | ||||
|       - name: Store Puppeteer artifacts | ||||
|         # Upload these on failure, as well | ||||
|         if: ${{ always() && matrix.include_frontend_tests }} | ||||
|         uses: actions/upload-artifact@v4 | ||||
|         uses: actions/upload-artifact@v2 | ||||
|         with: | ||||
|           name: puppeteer | ||||
|           path: ./var/puppeteer | ||||
|           retention-days: 60 | ||||
|  | ||||
|       - name: Check development database build | ||||
|         if: ${{ matrix.is_focal || matrix.is_bullseye }} | ||||
|         run: ./tools/ci/setup-backend | ||||
|  | ||||
|       - name: Verify pnpm store path | ||||
|         run: | | ||||
|           set -x | ||||
|           path="$(pnpm store path)" | ||||
|           [[ "$path" == /__w/.pnpm-store/* ]] | ||||
|  | ||||
|       - name: Generate failure report string | ||||
|         id: failure_report_string | ||||
|         if: ${{ failure() && github.repository == 'zulip/zulip' && github.event_name == 'push' }} | ||||
|         run: tools/ci/generate-failure-message >> $GITHUB_OUTPUT | ||||
|  | ||||
|       - name: Report status to CZO | ||||
|         if: ${{ failure() && github.repository == 'zulip/zulip' && github.event_name == 'push' }} | ||||
|         uses: zulip/github-actions-zulip/send-message@v1 | ||||
|         with: | ||||
|           api-key: ${{ secrets.ZULIP_BOT_KEY }} | ||||
|           email: "github-actions-bot@chat.zulip.org" | ||||
|           organization-url: "https://chat.zulip.org" | ||||
|           to: "automated testing" | ||||
|           topic: ${{ steps.failure_report_string.outputs.topic }} | ||||
|           type: "stream" | ||||
|           content: ${{ steps.failure_report_string.outputs.content }} | ||||
|       - name: Report status | ||||
|         if: failure() | ||||
|         env: | ||||
|           ZULIP_BOT_KEY: ${{ secrets.ZULIP_BOT_KEY }} | ||||
|         run: tools/ci/send-failure-message | ||||
|   | ||||
							
								
								
									
										20
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										20
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							| @@ -17,17 +17,13 @@ | ||||
| # See `git help ignore` for details on the format. | ||||
|  | ||||
| ## Config files for the dev environment | ||||
| /zproject/apns-dev.pem | ||||
| /zproject/apns-dev-key.p8 | ||||
| /zproject/dev-secrets.conf | ||||
| /zproject/custom_dev_settings.py | ||||
| /tools/conf.ini | ||||
| /tools/custom_provision | ||||
| /tools/droplets/conf.ini | ||||
|  | ||||
| ## Byproducts of setting up and using the dev environment | ||||
| *.pyc | ||||
| *.tsbuildinfo | ||||
| package-lock.json | ||||
|  | ||||
| /.vagrant | ||||
| @@ -37,7 +33,9 @@ package-lock.json | ||||
| !/var/puppeteer/test_credentials.d.ts | ||||
|  | ||||
| /.dmypy.json | ||||
| /.ruff_cache | ||||
|  | ||||
| # Dockerfiles generated for continuous integration | ||||
| /tools/ci/images | ||||
|  | ||||
| # Generated i18n data | ||||
| /locale/en | ||||
| @@ -48,11 +46,11 @@ package-lock.json | ||||
| # Static build | ||||
| *.mo | ||||
| npm-debug.log | ||||
| /.pnpm-store | ||||
| /node_modules | ||||
| /prod-static | ||||
| /staticfiles.json | ||||
| /webpack-stats-production.json | ||||
| /yarn-error.log | ||||
| zulip-git-version | ||||
|  | ||||
| # Test / analysis tools | ||||
| @@ -75,21 +73,15 @@ zulip.kdev4 | ||||
| *.kate-swp | ||||
| *.sublime-project | ||||
| *.sublime-workspace | ||||
| .vscode/ | ||||
| *.DS_Store | ||||
| # VS Code. Avoid checking in .vscode in general, while still specifying | ||||
| # recommended extensions for working with this repository. | ||||
| /.vscode/**/* | ||||
| !/.vscode/extensions.json | ||||
| # .cache/ is generated by VS Code test runner | ||||
| # .cache/ is generated by Visual Studio Code's test runner | ||||
| .cache/ | ||||
| .eslintcache | ||||
|  | ||||
| # Core dump files | ||||
| core | ||||
|  | ||||
| # Static generated files for landing page. | ||||
| /static/images/landing-page/hello/generated | ||||
|  | ||||
| ## Miscellaneous | ||||
| # (Ideally this section is empty.) | ||||
| .transifexrc | ||||
|   | ||||
							
								
								
									
										4
									
								
								.gitlint
									
									
									
									
									
								
							
							
						
						
									
										4
									
								
								.gitlint
									
									
									
									
									
								
							| @@ -1,13 +1,13 @@ | ||||
| [general] | ||||
| ignore=title-trailing-punctuation, body-min-length, body-is-missing | ||||
|  | ||||
| extra-path=tools/lib/gitlint_rules.py | ||||
| extra-path=tools/lib/gitlint-rules.py | ||||
|  | ||||
| [title-match-regex] | ||||
| regex=^(.+:\ )?[A-Z].+\.$ | ||||
|  | ||||
| [title-max-length] | ||||
| line-length=72 | ||||
| line-length=76 | ||||
|  | ||||
| [body-max-line-length] | ||||
| line-length=76 | ||||
|   | ||||
							
								
								
									
										134
									
								
								.mailmap
									
									
									
									
									
								
							
							
						
						
									
										134
									
								
								.mailmap
									
									
									
									
									
								
							| @@ -1,164 +1,40 @@ | ||||
| # This file teaches `git log` and friends the canonical names | ||||
| # and email addresses to use for our contributors. | ||||
| # | ||||
| # For details on the format, see: | ||||
| #   https://git.github.io/htmldocs/gitmailmap.html | ||||
| # | ||||
| # Handy commands for examining or adding to this file: | ||||
| # | ||||
| #     # shows all names/emails after mapping, sorted: | ||||
| #   $ git shortlog -es | sort -k2 | ||||
| # | ||||
| #     # shows raw names/emails, filtered by mapped name: | ||||
| #   $ git log --format='%an %ae' --author=$NAME | uniq -c | ||||
|  | ||||
| acrefoot <acrefoot@zulip.com> <acrefoot@alum.mit.edu> | ||||
| acrefoot <acrefoot@zulip.com> <acrefoot@dropbox.com> | ||||
| acrefoot <acrefoot@zulip.com> <acrefoot@humbughq.com> | ||||
| Adam Benesh <Adam.Benesh@gmail.com> | ||||
| Adam Benesh <Adam.Benesh@gmail.com> <Adam-Daniel.Benesh@t-systems.com> | ||||
| Adarsh Tiwari <xoldyckk@gmail.com> | ||||
| Aditya Chaudhary <aditya.chaudhary1558@gmail.com> | ||||
| Adnan Shabbir Husain <generaladnan139@gmail.com> | ||||
| Adnan Shabbir Husain <generaladnan139@gmail.com> <78212328+adnan-td@users.noreply.github.com> | ||||
| Alex Vandiver <alexmv@zulip.com> <alex@chmrr.net> | ||||
| Alex Vandiver <alexmv@zulip.com> <github@chmrr.net> | ||||
| Allen Rabinovich <allenrabinovich@yahoo.com> <allenr@humbughq.com> | ||||
| Allen Rabinovich <allenrabinovich@yahoo.com> <allenr@zulip.com> | ||||
| Alya Abbott <alya@zulip.com> <2090066+alya@users.noreply.github.com> | ||||
| Alya Abbott <alya@zulip.com> <alyaabbott@elance-odesk.com> | ||||
| Aman Agrawal <amanagr@zulip.com> | ||||
| Aman Agrawal <amanagr@zulip.com> <f2016561@pilani.bits-pilani.ac.in> | ||||
| Anders Kaseorg <anders@zulip.com> <anders@zulipchat.com> | ||||
| Anders Kaseorg <anders@zulip.com> <andersk@mit.edu> | ||||
| aparna-bhatt <aparnabhatt2001@gmail.com> <86338542+aparna-bhatt@users.noreply.github.com> | ||||
| Aryan Bhokare <aryan1bhokare@gmail.com> | ||||
| Aryan Bhokare <aryan1bhokare@gmail.com> <92683836+aryan-bhokare@users.noreply.github.com> | ||||
| Aryan Shridhar <aryanshridhar7@gmail.com> | ||||
| Aryan Shridhar <aryanshridhar7@gmail.com> <53977614+aryanshridhar@users.noreply.github.com> | ||||
| Ashwat Kumar Singh <ashwat.kumarsingh.met20@itbhu.ac.in> | ||||
| Austin Riba <austin@zulip.com> <austin@m51.io> | ||||
| Bedo Khaled <bedokhaled66@gmail.com> | ||||
| Bedo Khaled <bedokhaled66@gmail.com> <64221784+abdelrahman725@users.noreply.github.com> | ||||
| BIKI DAS <bikid475@gmail.com> | ||||
| Brijmohan Siyag <brijsiyag@gmail.com> | ||||
| Brock Whittaker <whittakerbrock@gmail.com> <bjwhitta@asu.edu> | ||||
| Brock Whittaker <whittakerbrock@gmail.com> <brock@zulip.com> | ||||
| Brock Whittaker <whittakerbrock@gmail.com> <brock@zulip.org> | ||||
| Brock Whittaker <whittakerbrock@gmail.com> <brock@zulipchat.org> | ||||
| Brock Whittaker <whittakerbrock@gmail.com> <brockwhittaker@Brocks-MacBook.local> | ||||
| Brock Whittaker <brock@zulipchat.com> <bjwhitta@asu.edu> | ||||
| Brock Whittaker <brock@zulipchat.com> <brockwhittaker@Brocks-MacBook.local> | ||||
| Brock Whittaker <brock@zulipchat.com> <brock@zulipchat.org> | ||||
| Chris Bobbe <cbobbe@zulip.com> <cbobbe@zulipchat.com> | ||||
| Chris Bobbe <cbobbe@zulip.com> <csbobbe@gmail.com> | ||||
| codewithnick <nikhilsingh526452@gmail.com> | ||||
| Danny Su <contact@dannysu.com> <opensource@emailengine.org> | ||||
| Dhruv Goyal <dhruvgoyal.dev@gmail.com> | ||||
| Dinesh <chdinesh1089@gmail.com> | ||||
| Dinesh <chdinesh1089@gmail.com> <chdinesh1089> | ||||
| Eeshan Garg <eeshan@zulip.com> <jerryguitarist@gmail.com> | ||||
| Eric Smith <erwsmith@gmail.com> <99841919+erwsmith@users.noreply.github.com> | ||||
| Evy Kassirer <evy@zulip.com> | ||||
| Evy Kassirer <evy@zulip.com> <evy.kassirer@gmail.com> | ||||
| Evy Kassirer <evy@zulip.com> <evykassirer@users.noreply.github.com> | ||||
| Ganesh Pawar <pawarg256@gmail.com> <58626718+ganpa3@users.noreply.github.com> | ||||
| Greg Price <greg@zulip.com> <gnprice@gmail.com> | ||||
| Greg Price <greg@zulip.com> <greg@zulipchat.com> | ||||
| Greg Price <greg@zulip.com> <price@mit.edu> | ||||
| Hardik Dharmani <Ddharmani99@gmail.com> <ddharmani99@gmail.com> | ||||
| Hemant Umre <hemantumre12@gmail.com> <87542880+HemantUmre12@users.noreply.github.com> | ||||
| Jai soni <jai_s@me.iitr.ac.in> | ||||
| Jai soni <jai_s@me.iitr.ac.in> <76561593+jai2201@users.noreply.github.com> | ||||
| Jeff Arnold <jbarnold@gmail.com> <jbarnold@humbughq.com> | ||||
| Jeff Arnold <jbarnold@gmail.com> <jbarnold@zulip.com> | ||||
| Jessica McKellar <jesstess@mit.edu> <jesstess@humbughq.com> | ||||
| Jessica McKellar <jesstess@mit.edu> <jesstess@zulip.com> | ||||
| John Lu <JohnLu10212004@gmail.com> | ||||
| John Lu <JohnLu10212004@gmail.com> <87673068+JohnLu2004@users.noreply.github.com> | ||||
| Joseph Ho <josephho678@gmail.com> | ||||
| Joseph Ho <josephho678@gmail.com> <62449508+Joelute@users.noreply.github.com> | ||||
| Julia Bichler <julia.bichler@tum.de> <74348920+juliaBichler01@users.noreply.github.com> | ||||
| Karl Stolley <karl@zulip.com> <karl@stolley.dev> | ||||
| Kevin Mehall <km@kevinmehall.net> <kevin@humbughq.com> | ||||
| Kevin Mehall <km@kevinmehall.net> <kevin@zulip.com> | ||||
| Kevin Scott <kevin.scott.98@gmail.com> | ||||
| Kislay Verma <kislayuv27@gmail.com> | ||||
| Kunal Sharma <v.shm.kunal@gmail.com> | ||||
| Lalit Kumar Singh <lalitkumarsingh3716@gmail.com> | ||||
| Lalit Kumar Singh <lalitkumarsingh3716@gmail.com> <lalits01@smartek21.com> | ||||
| Lauryn Menard <lauryn@zulip.com> <63245456+laurynmm@users.noreply.github.com> | ||||
| Lauryn Menard <lauryn@zulip.com> <lauryn.menard@gmail.com> | ||||
| m-e-l-u-h-a-n <purushottam.tiwari.cd.cse19@itbhu.ac.in> | ||||
| m-e-l-u-h-a-n <purushottam.tiwari.cd.cse19@itbhu.ac.in> <pururshottam.tiwari.cd.cse19@itbhu.ac.in> | ||||
| Mateusz Mandera <mateusz.mandera@zulip.com> <mateusz.mandera@protonmail.com> | ||||
| Matt Keller <matt@zulip.com> | ||||
| Matt Keller <matt@zulip.com> <m@cognusion.com> | ||||
| Nehal Sharma <bablinaneh@gmail.com> | ||||
| Nehal Sharma <bablinaneh@gmail.com> <68962290+N-Shar-ma@users.noreply.github.com> | ||||
| Nimish Medatwal <medatwalnimish@gmail.com> | ||||
| Noble Mittal <noblemittal@outlook.com> <62551163+beingnoble03@users.noreply.github.com> | ||||
| nzai <nzaih18@gmail.com> <70953556+nzaih1999@users.noreply.github.com> | ||||
| Palash Baderia <palash.baderia@outlook.com> | ||||
| Palash Baderia <palash.baderia@outlook.com> <66828942+palashb01@users.noreply.github.com> | ||||
| Palash Raghuwanshi <singhpalash0@gmail.com> | ||||
| Parth <mittalparth22@gmail.com> | ||||
| Pratik Chanda <pratikchanda2000@gmail.com> | ||||
| Pratik Solanki <pratiksolanki2021@gmail.com> | ||||
| Priyam Seth <sethpriyam1@gmail.com> <b19188@students.iitmandi.ac.in> | ||||
| Ray Kraesig <rkraesig@zulip.com> <rkraesig@zulipchat.com> | ||||
| Reid Barton <rwbarton@gmail.com> <rwbarton@humbughq.com> | ||||
| Rein Zustand (rht) <rhtbot@protonmail.com> | ||||
| Rishabh Maheshwari <b20063@students.iitmandi.ac.in> | ||||
| Rishi Gupta <rishig@zulipchat.com> <rishig+git@mit.edu> | ||||
| Rishi Gupta <rishig@zulipchat.com> <rishig@kandralabs.com> | ||||
| Rishi Gupta <rishig@zulipchat.com> <rishig@users.noreply.github.com> | ||||
| Rixant Rokaha <rixantrokaha@gmail.com> | ||||
| Rixant Rokaha <rixantrokaha@gmail.com> <rishantrokaha@gmail.com> | ||||
| Rixant Rokaha <rixantrokaha@gmail.com> <rrokaha@caldwell.edu> | ||||
| Rohan Gudimetla <rohan.gudimetla07@gmail.com> | ||||
| Sahil Batra <sahil@zulip.com> <35494118+sahil839@users.noreply.github.com> | ||||
| Sahil Batra <sahil@zulip.com> <sahilbatra839@gmail.com> | ||||
| Sanchit Sharma <ssharmas10662@gmail.com> | ||||
| Satyam Bansal <sbansal1999@gmail.com> | ||||
| Sayam Samal <samal.sayam@gmail.com> | ||||
| Reid Barton <rwbarton@gmail.com> <rwbarton@humbughq.com> | ||||
| Scott Feeney <scott@oceanbase.org> <scott@humbughq.com> | ||||
| Scott Feeney <scott@oceanbase.org> <scott@zulip.com> | ||||
| Shashank Singh <21bec103@iiitdmj.ac.in> | ||||
| Shlok Patel <shlokcpatel2001@gmail.com> | ||||
| Shu Chen <shu@zulip.com> | ||||
| Shubham Padia <shubham@zulip.com> | ||||
| Shubham Padia <shubham@zulip.com> <shubham@glints.com> | ||||
| Somesh Ranjan <somesh.ranjan.met20@itbhu.ac.in> <77766761+somesh202@users.noreply.github.com> | ||||
| Steve Howell <showell@zulip.com> <showell30@yahoo.com> | ||||
| Steve Howell <showell@zulip.com> <showell@yahoo.com> | ||||
| Steve Howell <showell@zulip.com> <showell@zulipchat.com> | ||||
| Steve Howell <showell@zulip.com> <steve@humbughq.com> | ||||
| Steve Howell <showell@zulip.com> <steve@zulip.com> | ||||
| strifel <info@strifel.de> | ||||
| Sujal Shah <sujalshah28092004@gmail.com> | ||||
| Tanmay Kumar <tnmdotkr@gmail.com> | ||||
| Tanmay Kumar <tnmdotkr@gmail.com> <133781250+tnmkr@users.noreply.github.com> | ||||
| Tim Abbott <tabbott@zulip.com> | ||||
| Tim Abbott <tabbott@zulip.com> <tabbott@dropbox.com> | ||||
| Tim Abbott <tabbott@zulip.com> <tabbott@humbughq.com> | ||||
| Tim Abbott <tabbott@zulip.com> <tabbott@mit.edu> | ||||
| Tim Abbott <tabbott@zulip.com> <tabbott@zulipchat.com> | ||||
| Tomasz Kolek <tomasz-kolek@o2.pl> <tomasz-kolek@go2.pl> | ||||
| Ujjawal Modi <umodi2003@gmail.com> <99073049+Ujjawal3@users.noreply.github.com> | ||||
| umkay <ukhan@zulipchat.com> <umaimah.k@gmail.com> | ||||
| umkay <ukhan@zulipchat.com> <umkay@users.noreply.github.com> | ||||
| Viktor Illmer <1476338+v-ji@users.noreply.github.com> | ||||
| Vishnu KS <vishnu@zulip.com> <hackerkid@vishnuks.com> | ||||
| Vishnu KS <vishnu@zulip.com> <yo@vishnuks.com> | ||||
| Waseem Daher <wdaher@zulip.com> <wdaher@dropbox.com> | ||||
| Waseem Daher <wdaher@zulip.com> <wdaher@humbughq.com> | ||||
| Yash RE <33805964+YashRE42@users.noreply.github.com> | ||||
| Yash RE <33805964+YashRE42@users.noreply.github.com> <YashRE42@github.com> | ||||
| Yogesh Sirsat <yogeshsirsat56@gmail.com> | ||||
| Yogesh Sirsat <yogeshsirsat56@gmail.com> <41695888+yogesh-sirsat@users.noreply.github.com> | ||||
| Zeeshan Equbal <equbalzeeshan@gmail.com> | ||||
| Zeeshan Equbal <equbalzeeshan@gmail.com> <54993043+zee-bit@users.noreply.github.com> | ||||
| Zev Benjamin <zev@zulip.com> <zev@dropbox.com> | ||||
| Zev Benjamin <zev@zulip.com> <zev@humbughq.com> | ||||
| Zev Benjamin <zev@zulip.com> <zev@mit.edu> | ||||
| Zixuan James Li <p359101898@gmail.com> | ||||
| Zixuan James Li <p359101898@gmail.com> <359101898@qq.com> | ||||
| Zixuan James Li <p359101898@gmail.com> <39874143+PIG208@users.noreply.github.com> | ||||
| Alya Abbott <alya@zulip.com> <alyaabbott@elance-odesk.com> | ||||
|   | ||||
| @@ -1,17 +1,8 @@ | ||||
| pnpm-lock.yaml | ||||
| /api_docs/**/*.md | ||||
| /corporate/tests/stripe_fixtures | ||||
| /help/**/*.md | ||||
| /locale | ||||
| /static/third | ||||
| /templates/**/*.md | ||||
| /tools/setup/emoji/emoji_map.json | ||||
| /web/third/* | ||||
| !/web/third/marked | ||||
| /web/third/marked/* | ||||
| !/web/third/marked/lib | ||||
| /web/third/marked/lib/* | ||||
| !/web/third/marked/lib/marked.d.ts | ||||
| /zerver/tests/fixtures | ||||
| /zerver/webhooks/*/doc.md | ||||
| /zerver/webhooks/github/githubsponsors.md | ||||
| /zerver/webhooks/*/fixtures | ||||
|   | ||||
| @@ -1,15 +0,0 @@ | ||||
| # https://docs.readthedocs.io/en/stable/config-file/v2.html | ||||
| version: 2 | ||||
|  | ||||
| build: | ||||
|   os: ubuntu-22.04 | ||||
|   tools: | ||||
|     python: "3.10" | ||||
|  | ||||
| sphinx: | ||||
|   configuration: docs/conf.py | ||||
|   fail_on_warning: true | ||||
|  | ||||
| python: | ||||
|   install: | ||||
|     - requirements: requirements/docs.txt | ||||
							
								
								
									
										27
									
								
								.tx/config
									
									
									
									
									
								
							
							
						
						
									
										27
									
								
								.tx/config
									
									
									
									
									
								
							| @@ -1,39 +1,32 @@ | ||||
| # Migrated from transifex-client format with `tx migrate` | ||||
| # | ||||
| # See https://developers.transifex.com/docs/using-the-client which hints at | ||||
| # this format, but in general, the headings are in the format of: | ||||
| # | ||||
| # [o:<org>:p:<project>:r:<resource>] | ||||
|  | ||||
| [main] | ||||
| host = https://www.transifex.com | ||||
| lang_map = zh-Hans: zh_Hans, zh-Hant: zh_Hant | ||||
|  | ||||
| [o:zulip:p:zulip:r:djangopo] | ||||
| [zulip.djangopo] | ||||
| file_filter = locale/<lang>/LC_MESSAGES/django.po | ||||
| source_file = locale/en/LC_MESSAGES/django.po | ||||
| source_lang = en | ||||
| type = PO | ||||
|  | ||||
| [o:zulip:p:zulip:r:mobile] | ||||
| [zulip.translationsjson] | ||||
| file_filter = locale/<lang>/translations.json | ||||
| source_file = locale/en/translations.json | ||||
| source_lang = en | ||||
| type = KEYVALUEJSON | ||||
|  | ||||
| [zulip.mobile] | ||||
| file_filter = locale/<lang>/mobile.json | ||||
| source_file = locale/en/mobile.json | ||||
| source_lang = en | ||||
| type = KEYVALUEJSON | ||||
|  | ||||
| [o:zulip:p:zulip:r:translationsjson] | ||||
| file_filter = locale/<lang>/translations.json | ||||
| source_file = locale/en/translations.json | ||||
| source_lang = en | ||||
| type = KEYVALUEJSON | ||||
|  | ||||
| [o:zulip:p:zulip-test:r:djangopo] | ||||
| [zulip-test.djangopo] | ||||
| file_filter = locale/<lang>/LC_MESSAGES/django.po | ||||
| source_file = locale/en/LC_MESSAGES/django.po | ||||
| source_lang = en | ||||
| type = PO | ||||
|  | ||||
| [o:zulip:p:zulip-test:r:translationsjson] | ||||
| [zulip-test.translationsjson] | ||||
| file_filter = locale/<lang>/translations.json | ||||
| source_file = locale/en/translations.json | ||||
| source_lang = en | ||||
|   | ||||
							
								
								
									
										23
									
								
								.vscode/extensions.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										23
									
								
								.vscode/extensions.json
									
									
									
									
										vendored
									
									
								
							| @@ -1,23 +0,0 @@ | ||||
| { | ||||
|     // Recommended VS Code extensions for zulip/zulip. | ||||
|     // | ||||
|     // VS Code prompts a user to install the recommended extensions | ||||
|     // when a workspace is opened for the first time.  The user can | ||||
|     // also review the list with the 'Extensions: Show Recommended | ||||
|     // Extensions' command.  See | ||||
|     // https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions | ||||
|     // for more information. | ||||
|     // | ||||
|     // Extension identifier format: ${publisher}.${name}. | ||||
|     // Example: vscode.csharp | ||||
|  | ||||
|     "recommendations": [ | ||||
|         "42crunch.vscode-openapi", | ||||
|         "dbaeumer.vscode-eslint", | ||||
|         "esbenp.prettier-vscode", | ||||
|         "ms-vscode-remote.vscode-remote-extensionpack" | ||||
|     ], | ||||
|  | ||||
|     // Extensions recommended by VS Code which are not recommended for users of zulip/zulip. | ||||
|     "unwantedRecommendations": [] | ||||
| } | ||||
| @@ -66,7 +66,7 @@ organizers may take any action they deem appropriate, up to and including a | ||||
| temporary ban or permanent expulsion from the community without warning (and | ||||
| without refund in the case of a paid event). | ||||
|  | ||||
| If someone outside the development community (e.g., a user of the Zulip | ||||
| If someone outside the development community (e.g. a user of the Zulip | ||||
| software) engages in unacceptable behavior that affects someone in the | ||||
| community, we still want to know. Even if we don't have direct control over | ||||
| the violator, the community organizers can still support the people | ||||
| @@ -102,72 +102,3 @@ This Code of Conduct is adapted from the | ||||
| under a | ||||
| [Creative Commons BY-SA](https://creativecommons.org/licenses/by-sa/4.0/) | ||||
| license. | ||||
|  | ||||
| ## Moderating the Zulip community | ||||
|  | ||||
| Anyone can help moderate the Zulip community by helping make sure that folks are | ||||
| aware of the [community guidelines](https://zulip.com/development-community/) | ||||
| and this Code of Conduct, and that we maintain a positive and respectful | ||||
| atmosphere. | ||||
|  | ||||
| Here are some guidelines for you how can help: | ||||
|  | ||||
| - Be friendly! Welcoming folks, thanking them for their feedback, ideas and effort, | ||||
|   and just trying to keep the atmosphere warm make the whole community function | ||||
|   more smoothly. New participants who feel accepted, listened to and respected | ||||
|   are likely to treat others the same way. | ||||
|  | ||||
| - Be familiar with the [community | ||||
|   guidelines](https://zulip.com/development-community/), and cite them liberally | ||||
|   when a user violates them. Be polite but firm. Some examples: | ||||
|  | ||||
|   - @user please note that there is no need to @-mention @\_**Tim Abbott** when | ||||
|     you ask a question. As noted in the [guidelines for this | ||||
|     community](https://zulip.com/development-community/): | ||||
|  | ||||
|     > Use @-mentions sparingly… there is generally no need to @-mention a | ||||
|     > core contributor unless you need their timely attention. | ||||
|  | ||||
|   - @user, please keep in mind the following [community | ||||
|     guideline](https://zulip.com/development-community/): | ||||
|  | ||||
|     > Don’t ask the same question in multiple places. Moderators read every | ||||
|     > public stream, and make sure every question gets a reply. | ||||
|  | ||||
|     I’ve gone ahead and moved the other copy of this message to this thread. | ||||
|  | ||||
|   - If asked a question in a direct message that is better discussed in a public | ||||
|     stream: | ||||
|     > Hi @user! Please start by reviewing | ||||
|     > https://zulip.com/development-community/#community-norms to learn how to | ||||
|     > get help in this community. | ||||
|  | ||||
| - Users sometimes think chat.zulip.org is a testing instance. When this happens, | ||||
|   kindly direct them to use the **#test here** stream. | ||||
|  | ||||
| - If you see a message that’s posted in the wrong place, go ahead and move it if | ||||
|   you have permissions to do so, even if you don’t plan to respond to it. | ||||
|   Leaving the “Send automated notice to new topic” option enabled helps make it | ||||
|   clear what happened to the person who sent the message. | ||||
|  | ||||
|   If you are responding to a message that's been moved, mention the user in your | ||||
|   reply, so that the mention serves as a notification of the new location for | ||||
|   their conversation. | ||||
|  | ||||
| - If a user is posting spam, please report it to an administrator. They will: | ||||
|  | ||||
|   - Change the user's name to `<name> (spammer)` and deactivate them. | ||||
|   - Delete any spam messages they posted in public streams. | ||||
|  | ||||
| - We care very much about maintaining a respectful tone in our community. If you | ||||
|   see someone being mean or rude, point out that their tone is inappropriate, | ||||
|   and ask them to communicate their perspective in a respectful way in the | ||||
|   future. If you don’t feel comfortable doing so yourself, feel free to ask a | ||||
|   member of Zulip's core team to take care of the situation. | ||||
|  | ||||
| - Try to assume the best intentions from others (given the range of | ||||
|   possibilities presented by their visible behavior), and stick with a friendly | ||||
|   and positive tone even when someone’s behavior is poor or disrespectful. | ||||
|   Everyone has bad days and stressful situations that can result in them | ||||
|   behaving not their best, and while we should be firm about our community | ||||
|   rules, we should also enforce them with kindness. | ||||
|   | ||||
							
								
								
									
										548
									
								
								CONTRIBUTING.md
									
									
									
									
									
								
							
							
						
						
									
										548
									
								
								CONTRIBUTING.md
									
									
									
									
									
								
							| @@ -1,36 +1,24 @@ | ||||
| # Contributing guide | ||||
| # Contributing to Zulip | ||||
|  | ||||
| Welcome to the Zulip community! | ||||
|  | ||||
| ## Zulip development community | ||||
| ## Community | ||||
|  | ||||
| The primary communication forum for the Zulip community is the Zulip | ||||
| server hosted at [chat.zulip.org](https://chat.zulip.org/): | ||||
| The | ||||
| [Zulip community server](https://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html) | ||||
| is the primary communication forum for the Zulip community. It is a good | ||||
| place to start whether you have a question, are a new contributor, are a new | ||||
| user, or anything else. Make sure to read the | ||||
| [community norms](https://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html#community-norms) | ||||
| before posting. The Zulip community is also governed by a | ||||
| [code of conduct](https://zulip.readthedocs.io/en/latest/code-of-conduct.html). | ||||
|  | ||||
| - **Users** and **administrators** of Zulip organizations stop by to | ||||
|   ask questions, offer feedback, and participate in product design | ||||
|   discussions. | ||||
| - **Contributors to the project**, including the **core Zulip | ||||
|   development team**, discuss ongoing and future projects, brainstorm | ||||
|   ideas, and generally help each other out. | ||||
|  | ||||
| Everyone is welcome to [sign up](https://chat.zulip.org/) and | ||||
| participate — we love hearing from our users! Public streams in the | ||||
| community receive thousands of messages a week. We recommend signing | ||||
| up using the special invite links for | ||||
| [users](https://chat.zulip.org/join/t5crtoe62bpcxyisiyglmtvb/), | ||||
| [self-hosters](https://chat.zulip.org/join/wnhv3jzm6afa4raenedanfno/) | ||||
| and | ||||
| [contributors](https://chat.zulip.org/join/npzwak7vpmaknrhxthna3c7p/) | ||||
| to get a curated list of initial stream subscriptions. | ||||
|  | ||||
| To learn how to get started participating in the community, including [community | ||||
| norms](https://zulip.com/development-community/#community-norms) and [where to | ||||
| post](https://zulip.com/development-community/#where-do-i-send-my-message), | ||||
| check out our [Zulip development community | ||||
| guide](https://zulip.com/development-community/). The Zulip community is | ||||
| governed by a [code of | ||||
| conduct](https://zulip.readthedocs.io/en/latest/code-of-conduct.html). | ||||
| You can subscribe to | ||||
| [zulip-devel-announce@googlegroups.com](https://groups.google.com/g/zulip-devel-announce) | ||||
| or our [Twitter](https://twitter.com/zulip) account for a very low | ||||
| traffic (<1 email/month) way to hear about things like mentorship | ||||
| opportunities with Google Summer of Code, in-person sprints at | ||||
| conferences, and other opportunities to contribute. | ||||
|  | ||||
| ## Ways to contribute | ||||
|  | ||||
| @@ -41,9 +29,9 @@ needs doing: | ||||
|  | ||||
| - Bug squashing and feature development on our Python/Django | ||||
|   [backend](https://github.com/zulip/zulip), web | ||||
|   [frontend](https://github.com/zulip/zulip), | ||||
|   Flutter [mobile app](https://github.com/zulip/zulip-flutter) in beta, | ||||
|   or Electron [desktop app](https://github.com/zulip/zulip-desktop). | ||||
|   [frontend](https://github.com/zulip/zulip), React Native | ||||
|   [mobile app](https://github.com/zulip/zulip-mobile), or Electron | ||||
|   [desktop app](https://github.com/zulip/zulip-desktop). | ||||
| - Building out our | ||||
|   [Python API and bots](https://github.com/zulip/python-zulip-api) framework. | ||||
| - [Writing an integration](https://zulip.com/api/integrations-overview). | ||||
| @@ -53,23 +41,18 @@ needs doing: | ||||
|   and manually testing pull requests. | ||||
|  | ||||
| **Non-code contributions**: Some of the most valuable ways to contribute | ||||
| don't require touching the codebase at all. For example, you can: | ||||
| don't require touching the codebase at all. We list a few of them below: | ||||
|  | ||||
| - Report issues, including both [feature | ||||
|   requests](https://zulip.readthedocs.io/en/latest/contributing/suggesting-features.html) | ||||
|   and [bug | ||||
|   reports](https://zulip.readthedocs.io/en/latest/contributing/reporting-bugs.html). | ||||
| - [Give feedback](#user-feedback) if you are evaluating or using Zulip. | ||||
| - [Participate | ||||
|   thoughtfully](https://zulip.readthedocs.io/en/latest/contributing/design-discussions.html) | ||||
|   in design discussions. | ||||
| - [Reporting issues](#reporting-issues), including both feature requests and | ||||
|   bug reports. | ||||
| - [Giving feedback](#user-feedback) if you are evaluating or using Zulip. | ||||
| - [Sponsor Zulip](https://github.com/sponsors/zulip) through the GitHub sponsors program. | ||||
| - [Translate](https://zulip.readthedocs.io/en/latest/translating/translating.html) | ||||
|   Zulip into your language. | ||||
| - [Stay connected](#stay-connected) with Zulip, and [help others | ||||
|   find us](#help-others-find-zulip). | ||||
| - [Translating](https://zulip.readthedocs.io/en/latest/translating/translating.html) | ||||
|   Zulip. | ||||
| - [Outreach](#zulip-outreach): Star us on GitHub, upvote us | ||||
|   on product comparison sites, or write for [the Zulip blog](https://blog.zulip.org/). | ||||
|  | ||||
| ## Your first codebase contribution | ||||
| ## Your first (codebase) contribution | ||||
|  | ||||
| This section has a step by step guide to starting as a Zulip codebase | ||||
| contributor. It's long, but don't worry about doing all the steps perfectly; | ||||
| @@ -77,283 +60,167 @@ no one gets it right the first time, and there are a lot of people available | ||||
| to help. | ||||
|  | ||||
| - First, make an account on the | ||||
|   [Zulip community server](https://zulip.com/development-community/), | ||||
|   paying special attention to the | ||||
|   [community norms](https://zulip.com/development-community/#community-norms). | ||||
|   If you'd like, introduce yourself in | ||||
|   [#new members](https://chat.zulip.org/#narrow/channel/95-new-members), using | ||||
|   [Zulip community server](https://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html), | ||||
|   paying special attention to the community norms. If you'd like, introduce | ||||
|   yourself in | ||||
|   [#new members](https://chat.zulip.org/#narrow/stream/95-new-members), using | ||||
|   your name as the topic. Bonus: tell us about your first impressions of | ||||
|   Zulip, and anything that felt confusing/broken or interesting/helpful as you | ||||
|   started using the product. | ||||
|  | ||||
|   Zulip, and anything that felt confusing/broken as you started using the | ||||
|   product. | ||||
| - Read [What makes a great Zulip contributor](#what-makes-a-great-zulip-contributor). | ||||
|  | ||||
| - Set up the development environment for the Zulip codebase you want | ||||
|   to work on, and start getting familiar with the code. | ||||
|  | ||||
|   - For the server and web app: | ||||
|  | ||||
| - [Install the development environment](https://zulip.readthedocs.io/en/latest/development/overview.html), | ||||
|   getting help in | ||||
|       [#provision help](https://chat.zulip.org/#narrow/channel/21-provision-help) | ||||
|   [#development help](https://chat.zulip.org/#narrow/stream/49-development-help) | ||||
|   if you run into any troubles. | ||||
|     - Familiarize yourself with [using the development environment](https://zulip.readthedocs.io/en/latest/development/using.html). | ||||
|     - Go through the [new application feature | ||||
|       tutorial](https://zulip.readthedocs.io/en/latest/tutorials/new-feature-tutorial.html) to get familiar with | ||||
|       how the Zulip codebase is organized and how to find code in it. | ||||
| - Read the | ||||
|   [Zulip guide to Git](https://zulip.readthedocs.io/en/latest/git/index.html) | ||||
|   and do the Git tutorial (coming soon) if you are unfamiliar with | ||||
|   Git, getting help in | ||||
|   [#git help](https://chat.zulip.org/#narrow/stream/44-git-help) if | ||||
|   you run into any troubles. Be sure to check out the | ||||
|   [extremely useful Zulip-specific tools page](https://zulip.readthedocs.io/en/latest/git/zulip-tools.html). | ||||
|  | ||||
|   - For the upcoming Flutter-based mobile app: | ||||
|     - Set up a development environment following the instructions in | ||||
|       [the project README](https://github.com/zulip/zulip-flutter). | ||||
|     - Start reading recent commits to see the code we're writing. | ||||
|       Use either a [graphical Git viewer][] like `gitk`, or `git log -p` | ||||
|       with [the "secret" to reading its output][git-log-secret]. | ||||
|     - Pick some of the code that appears in those Git commits and | ||||
|       that looks interesting. Use your IDE to visit that code | ||||
|       and to navigate to related code, reading to see how it works | ||||
|       and how the codebase is organized. | ||||
| ### Picking an issue | ||||
|  | ||||
| - Read the [Zulip guide to | ||||
|   Git](https://zulip.readthedocs.io/en/latest/git/index.html) if you | ||||
|   are unfamiliar with Git or Zulip's rebase-based Git workflow, | ||||
|   getting help in [#git | ||||
|   help](https://chat.zulip.org/#narrow/channel/44-git-help) if you run | ||||
|   into any troubles. Even Git experts should read the [Zulip-specific | ||||
|   Git tools | ||||
|   page](https://zulip.readthedocs.io/en/latest/git/zulip-tools.html). | ||||
| Now, you're ready to pick your first issue! There are hundreds of open issues | ||||
| in the main codebase alone. This section will help you find an issue to work | ||||
| on. | ||||
|  | ||||
| [graphical Git viewer]: https://zulip.readthedocs.io/en/latest/git/setup.html#get-a-graphical-client | ||||
| [git-log-secret]: https://github.com/zulip/zulip-mobile/blob/main/docs/howto/git.md#git-log-secret | ||||
|  | ||||
| ### Where to look for an issue | ||||
|  | ||||
| Now you're ready to pick your first issue! Zulip has several repositories you | ||||
| can check out, depending on your interests. There are hundreds of open issues in | ||||
| the [main Zulip server and web app | ||||
| repository](https://github.com/zulip/zulip/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) | ||||
| alone. | ||||
|  | ||||
| You can look through issues tagged with the "help wanted" label, which is used | ||||
| to indicate the issues that are ready for contributions. Some repositories also | ||||
| use the "good first issue" label to tag issues that are especially approachable | ||||
| for new contributors. | ||||
|  | ||||
| - [Server and web app](https://github.com/zulip/zulip/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) | ||||
| - Mobile apps: no "help wanted" label, but see the | ||||
|   [project board](https://github.com/orgs/zulip/projects/5/views/4) | ||||
|   for the upcoming Flutter-based app. Look for issues up through the | ||||
|   "Launch" milestone, and that aren't already assigned. | ||||
| - [Desktop app](https://github.com/zulip/zulip-desktop/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) | ||||
| - [Terminal app](https://github.com/zulip/zulip-terminal/issues?q=is%3Aopen+is%3Aissue+label%3A"help+wanted") | ||||
| - [Python API bindings and bots](https://github.com/zulip/python-zulip-api/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) | ||||
|  | ||||
| ### Picking an issue to work on | ||||
|  | ||||
| There's a lot to learn while making your first pull request, so start small! | ||||
| Many first contributions have fewer than 10 lines of changes (not counting | ||||
| changes to tests). | ||||
|  | ||||
| We recommend the following process for finding an issue to work on: | ||||
|  | ||||
| 1. Read the description of an issue tagged with the "help wanted" label and make | ||||
|    sure you understand it. | ||||
| 2. If it seems promising, poke around the product | ||||
|    (on [chat.zulip.org](https://chat.zulip.org) or in the development | ||||
|    environment) until you know how the piece being | ||||
|    described fits into the bigger picture. If after some exploration the | ||||
|    description seems confusing or ambiguous, post a question on the GitHub | ||||
|    issue, as others may benefit from the clarification as well. | ||||
| 3. When you find an issue you like, try to get started working on it. See if you | ||||
|    can find the part of the code you'll need to modify (`git grep` is your | ||||
|    friend!) and get some idea of how you'll approach the problem. | ||||
| 4. If you feel lost, that's OK! Go through these steps again with another issue. | ||||
|    There's plenty to work on, and the exploration you do will help you learn | ||||
|    more about the project. | ||||
|  | ||||
| Note that you are _not_ claiming an issue while you are iterating through steps | ||||
| 1-4. _Before you claim an issue_, you should be confident that you will be able to | ||||
| tackle it effectively. | ||||
|  | ||||
| Additional tips for the [main server and web app | ||||
| repository](https://github.com/zulip/zulip/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22): | ||||
|  | ||||
| - We especially recommend browsing recently opened issues, as there are more | ||||
|   likely to be easy ones for you to find. | ||||
| - Take a look at issues with the ["good first issue" | ||||
|   label](https://github.com/zulip/zulip/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), | ||||
|   as they are especially accessible to new contributors. However, you will | ||||
|   likely find issues without this label that are accessible as well. | ||||
| - All issues are partitioned into areas like | ||||
| - If you're interested in | ||||
|   [mobile](https://github.com/zulip/zulip-mobile/issues?q=is%3Aopen+is%3Aissue), | ||||
|   [desktop](https://github.com/zulip/zulip-desktop/issues?q=is%3Aopen+is%3Aissue), | ||||
|   or | ||||
|   [bots](https://github.com/zulip/python-zulip-api/issues?q=is%3Aopen+is%3Aissue) | ||||
|   development, check the respective links for open issues, or post in | ||||
|   [#mobile](https://chat.zulip.org/#narrow/stream/48-mobile), | ||||
|   [#desktop](https://chat.zulip.org/#narrow/stream/16-desktop), or | ||||
|   [#integration](https://chat.zulip.org/#narrow/stream/127-integrations). | ||||
| - For the main server and web repository, we recommend browsing | ||||
|   recently opened issues to look for issues you are confident you can | ||||
|   fix correctly in a way that clearly communicates why your changes | ||||
|   are the correct fix. Our GitHub workflow bot, zulipbot, limits | ||||
|   users who have 0 commits merged to claiming a single issue labeled | ||||
|   with "good first issue" or "help wanted". | ||||
| - We also partition all of our issues in the main repo into areas like | ||||
|   admin, compose, emoji, hotkeys, i18n, onboarding, search, etc. Look | ||||
|   through our [list of labels](https://github.com/zulip/zulip/labels), and | ||||
|   click on some of the `area:` labels to see all the issues related to your | ||||
|   areas of interest. | ||||
| - Avoid issues with the "difficult" label unless you | ||||
|   understand why it is difficult and are highly confident you can resolve the | ||||
|   issue correctly and completely. | ||||
| - If the lists of issues are overwhelming, post in | ||||
|   [#new members](https://chat.zulip.org/#narrow/stream/95-new-members) with a | ||||
|   bit about your background and interests, and we'll help you out. The most | ||||
|   important thing to say is whether you're looking for a backend (Python), | ||||
|   frontend (JavaScript and TypeScript), mobile (React Native), desktop (Electron), | ||||
|   documentation (English) or visual design (JavaScript/TypeScript + CSS) issue, and a | ||||
|   bit about your programming experience and available time. | ||||
|  | ||||
| ### Claiming an issue | ||||
| We also welcome suggestions of features that you feel would be valuable or | ||||
| changes that you feel would make Zulip a better open source project. If you | ||||
| have a new feature you'd like to add, we recommend you start by posting in | ||||
| [#new members](https://chat.zulip.org/#narrow/stream/95-new-members) with the | ||||
| feature idea and the problem that you're hoping to solve. | ||||
|  | ||||
| #### In the main server/web app repository and Zulip Terminal repository | ||||
| Other notes: | ||||
|  | ||||
| The Zulip server/web app repository | ||||
| ([`zulip/zulip`](https://github.com/zulip/zulip/)) and the Zulip Terminal | ||||
| repository ([`zulip/zulip-terminal`](https://github.com/zulip/zulip-terminal/)) | ||||
| are set up with a GitHub workflow bot called | ||||
| [Zulipbot](https://github.com/zulip/zulipbot), which manages issues and pull | ||||
| requests in order to create a better workflow for Zulip contributors. | ||||
|  | ||||
| To claim an issue in these repositories, simply post a comment that says | ||||
| `@zulipbot claim` to the issue thread. If the issue is tagged with a [help | ||||
| wanted](https://github.com/zulip/zulip/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) | ||||
| label, Zulipbot will immediately assign the issue to you. | ||||
|  | ||||
| Note that new contributors can only claim one issue until their first pull request is | ||||
| merged. This is to encourage folks to finish ongoing work before starting | ||||
| something new. If you would like to pick up a new issue while waiting for review | ||||
| on an almost-ready pull request, you can post a comment to this effect on the | ||||
| issue you're interested in. | ||||
|  | ||||
| #### In other Zulip repositories | ||||
|  | ||||
| There is no bot for other Zulip repositories | ||||
| ([`zulip/zulip-flutter`](https://github.com/zulip/zulip-flutter/), etc.). If | ||||
| you are interested in claiming an issue in one of these repositories, simply | ||||
| post a comment on the issue thread saying that you'd like to work on it. There | ||||
| is no need to @-mention the issue creator in your comment. | ||||
|  | ||||
| Please follow the same guidelines as described above: find an issue labeled | ||||
| "help wanted", and only pick up one issue at a time to start with. | ||||
| - For a first pull request, it's better to aim for a smaller contribution | ||||
|   than a bigger one. Many first contributions have fewer than 10 lines of | ||||
|   changes (not counting changes to tests). | ||||
| - The full list of issues explicitly looking for a contributor can be | ||||
|   found with the | ||||
|   [good first issue](https://github.com/zulip/zulip/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) | ||||
|   and | ||||
|   [help wanted](https://github.com/zulip/zulip/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) | ||||
|   labels. Avoid issues with the "difficult" label unless you | ||||
|   understand why it is difficult and are confident you can resolve the | ||||
|   issue correctly and completely. Issues without one of these labels | ||||
|   are fair game if Tim has written a clear technical design proposal | ||||
|   in the issue, or it is a bug that you can reproduce and you are | ||||
|   confident you can fix the issue correctly. | ||||
| - For most new contributors, there's a lot to learn while making your first | ||||
|   pull request. It's OK if it takes you a while; that's normal! You'll be | ||||
|   able to work a lot faster as you build experience. | ||||
|  | ||||
| ### Working on an issue | ||||
|  | ||||
| You're encouraged to ask questions on how to best implement or debug your | ||||
| changes -- the Zulip maintainers are excited to answer questions to help you | ||||
| stay unblocked and working efficiently. You can ask questions in the [Zulip | ||||
| development community](https://zulip.com/development-community/), or on the | ||||
| GitHub issue or pull request. | ||||
| To work on an issue, claim it by adding a comment with `@zulipbot claim` to | ||||
| the issue thread. [Zulipbot](https://github.com/zulip/zulipbot) is a GitHub | ||||
| workflow bot; it will assign you to the issue and label the issue as "in | ||||
| progress". Some additional notes: | ||||
|  | ||||
| To get early feedback on any UI changes, we encourage you to post screenshots of | ||||
| your work in the [#design | ||||
| stream](https://chat.zulip.org/#narrow/channel/101-design) in the [Zulip | ||||
| development community](https://zulip.com/development-community/) | ||||
| - You can only claim issues with the | ||||
|   [good first issue](https://github.com/zulip/zulip/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) | ||||
|   or | ||||
|   [help wanted](https://github.com/zulip/zulip/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) | ||||
|   labels. Zulipbot will give you an error if you try to claim an issue | ||||
|   without one of those labels. | ||||
| - You're encouraged to ask questions on how to best implement or debug your | ||||
|   changes -- the Zulip maintainers are excited to answer questions to help | ||||
|   you stay unblocked and working efficiently. You can ask questions on | ||||
|   chat.zulip.org, or on the GitHub issue or pull request. | ||||
| - We encourage early pull requests for work in progress. Prefix the title of | ||||
|   work in progress pull requests with `[WIP]`, and remove the prefix when | ||||
|   you think it might be mergeable and want it to be reviewed. | ||||
| - After updating a PR, add a comment to the GitHub thread mentioning that it | ||||
|   is ready for another review. GitHub only notifies maintainers of the | ||||
|   changes when you post a comment, so if you don't, your PR will likely be | ||||
|   neglected by accident! | ||||
|  | ||||
| For more advice, see [What makes a great Zulip | ||||
| contributor?](#what-makes-a-great-zulip-contributor) below. It's OK if your | ||||
| first issue takes you a while; that's normal! You'll be able to work a lot | ||||
| faster as you build experience. | ||||
| ### And beyond | ||||
|  | ||||
| ### Submitting a pull request | ||||
|  | ||||
| See the [guide on submitting a pull | ||||
| request](https://zulip.readthedocs.io/en/latest/contributing/reviewable-prs.html) | ||||
| for detailed instructions on how to present your proposed changes to Zulip. | ||||
|  | ||||
| The [pull request review process | ||||
| guide](https://zulip.readthedocs.io/en/latest/contributing/review-process.html) | ||||
| explains the stages of review your PR will go through, and offers guidance on | ||||
| how to help the review process move forward. | ||||
|  | ||||
| ### Beyond the first issue | ||||
|  | ||||
| To find a second issue to work on, we recommend looking through issues with the same | ||||
| A great place to look for a second issue is to look for issues with the same | ||||
| `area:` label as the last issue you resolved. You'll be able to reuse the | ||||
| work you did learning how that part of the codebase works. Also, the path to | ||||
| becoming a core developer often involves taking ownership of one of these area | ||||
| labels. | ||||
|  | ||||
| ### Common questions | ||||
|  | ||||
| - **What if somebody is already working on the issue I want do claim?** There | ||||
|   are lots of issue to work on! If somebody else is actively working on the | ||||
|   issue, you can find a different one, or help with | ||||
|   reviewing their work. | ||||
| - **What if somebody else claims an issue while I'm figuring out whether or not to | ||||
|   work on it?** No worries! You can contribute by providing feedback on | ||||
|   their pull request. If you've made good progress in understanding part of the | ||||
|   codebase, you can also find another "help wanted" issue in the same area to | ||||
|   work on. | ||||
| - **What if there is already a pull request for the issue I want to work on?** | ||||
|   Start by reviewing the existing work. If you agree with the approach, you can | ||||
|   use the existing pull request (PR) as a starting point for your contribution. If | ||||
|   you think a different approach is needed, you can post a new PR, with a comment that clearly | ||||
|   explains _why_ you decided to start from scratch. | ||||
| - **What if I ask if someone is still working on an issue, and they don't | ||||
|   respond?** If you don't get a reply within 2-3 days, go ahead and post a comment | ||||
|   that you are working on the issue, and submit a pull request. If the original | ||||
|   assignee ends up submitting a pull request first, no worries! You can help by | ||||
|   providing feedback on their work, or submit your own PR if you think a | ||||
|   different approach is needed (as described above). | ||||
| - **Can I come up with my own feature idea and work on it?** We welcome | ||||
|   suggestions of features or other improvements that you feel would be valuable. If you | ||||
|   have a new feature you'd like to add, you can start a conversation [in our | ||||
|   development community](https://zulip.com/development-community/#where-do-i-send-my-message) | ||||
|   explaining the feature idea and the problem that you're hoping to solve. | ||||
| - **I'm waiting for the next round of review on my PR. Can I pick up | ||||
|   another issue in the meantime?** Someone's first Zulip PR often | ||||
|   requires quite a bit of iteration, so please [make sure your pull | ||||
|   request is reviewable][reviewable-pull-requests] and go through at | ||||
|   least one round of feedback from others before picking up a second | ||||
|   issue. After that, sure! If | ||||
|   [Zulipbot](https://github.com/zulip/zulipbot) does not allow you to | ||||
|   claim an issue, you can post a comment describing the status of your | ||||
|   other work on the issue you're interested in, and asking for the | ||||
|   issue to be assigned to you. Note that addressing feedback on | ||||
|   in-progress PRs should always take priority over starting a new PR. | ||||
| - **I think my PR is done, but it hasn't been merged yet. What's going on?** | ||||
|   1. **Double-check that you have addressed all the feedback**, including any comments | ||||
|      on [Git commit | ||||
|      discipline](https://zulip.readthedocs.io/en/latest/contributing/commit-discipline.html). | ||||
|   2. If all the feedback has been addressed, did you [leave a | ||||
|      comment](https://zulip.readthedocs.io/en/latest/contributing/review-process.html#how-to-help-move-the-review-process-forward) | ||||
|      explaining that you have done so and **requesting another review**? If not, | ||||
|      it may not be clear to project maintainers or reviewers that your PR is | ||||
|      ready for another look. | ||||
|   3. There may be a pause between initial rounds of review for your PR and final | ||||
|      review by project maintainers. This is normal, and we encourage you to **work | ||||
|      on other issues** while you wait. | ||||
|   4. If you think the PR is ready and haven't seen any updates for a couple | ||||
|      of weeks, it can be helpful to **leave another comment**. Summarize the | ||||
|      overall state of the review process and your work, and indicate that you | ||||
|      are waiting for a review. | ||||
|   5. Finally, **Zulip project maintainers are people too**! They may be busy | ||||
|      with other work, and sometimes they might even take a vacation. ;) It can | ||||
|      occasionally take a few weeks for a PR in the final stages of the review | ||||
|      process to be merged. | ||||
|  | ||||
| [reviewable-pull-requests]: https://zulip.readthedocs.io/en/latest/contributing/reviewable-prs.html | ||||
|  | ||||
| ## What makes a great Zulip contributor? | ||||
|  | ||||
| Zulip has a lot of experience working with new contributors. In our | ||||
| experience, these are the best predictors of success: | ||||
|  | ||||
| - [Asking great questions][great-questions]. It's very hard to answer a general | ||||
|   question like, "How do I do this issue?" When asking for help, explain your | ||||
|   current understanding, including what you've done or tried so far and where | ||||
|   you got stuck. Post tracebacks or other error messages if appropriate. For | ||||
|   more advice, check out [our guide][great-questions]! | ||||
| - Posting good questions. This generally means explaining your current | ||||
|   understanding, saying what you've done or tried so far, and including | ||||
|   tracebacks or other error messages if appropriate. | ||||
| - Learning and practicing | ||||
|   [Git commit discipline](https://zulip.readthedocs.io/en/latest/contributing/commit-discipline.html). | ||||
| - Submitting carefully tested code. See our [detailed guide on how to review | ||||
|   code](https://zulip.readthedocs.io/en/latest/contributing/code-reviewing.html#how-to-review-code) | ||||
|   (yours or someone else's). | ||||
|   [Git commit discipline](https://zulip.readthedocs.io/en/latest/contributing/version-control.html#commit-discipline). | ||||
| - Submitting carefully tested code. This generally means checking your work | ||||
|   through a combination of automated tests and manually clicking around the | ||||
|   UI trying to find bugs in your work. See | ||||
|   [things to look for](https://zulip.readthedocs.io/en/latest/contributing/code-reviewing.html#things-to-look-for) | ||||
|   for additional ideas. | ||||
| - Posting | ||||
|   [screenshots or GIFs](https://zulip.readthedocs.io/en/latest/tutorials/screenshot-and-gif-software.html) | ||||
|   for frontend changes. | ||||
| - Working to [make your pull requests easy to | ||||
|   review](https://zulip.readthedocs.io/en/latest/contributing/reviewable-prs.html). | ||||
| - Clearly describing what you have implemented and why. For example, if your | ||||
|   implementation differs from the issue description in some way or is a partial | ||||
|   step towards the requirements described in the issue, be sure to call | ||||
|   out those differences. | ||||
| - Being responsive to feedback on pull requests. This means incorporating or | ||||
|   responding to all suggested changes, and leaving a note if you won't be | ||||
|   able to address things within a few days. | ||||
| - Being helpful and friendly on the [Zulip community | ||||
|   server](https://zulip.com/development-community/). | ||||
| - Being helpful and friendly on chat.zulip.org. | ||||
|  | ||||
| [great-questions]: https://zulip.readthedocs.io/en/latest/contributing/asking-great-questions.html | ||||
| These are also the main criteria we use to select candidates for all | ||||
| of our outreach programs. | ||||
|  | ||||
| ## Reporting issues | ||||
|  | ||||
| If you find an easily reproducible bug and/or are experienced in reporting | ||||
| bugs, feel free to just open an issue on the relevant project on GitHub. | ||||
|  | ||||
| If you have a feature request or are not yet sure what the underlying bug | ||||
| is, the best place to post issues is | ||||
| [#issues](https://chat.zulip.org/#narrow/stream/9-issues) (or | ||||
| [#mobile](https://chat.zulip.org/#narrow/stream/48-mobile) or | ||||
| [#desktop](https://chat.zulip.org/#narrow/stream/16-desktop)) on the | ||||
| [Zulip community server](https://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html). | ||||
| This allows us to interactively figure out what is going on, let you know if | ||||
| a similar issue has already been opened, and collect any other information | ||||
| we need. Choose a 2-4 word topic that describes the issue, explain the issue | ||||
| and how to reproduce it if known, your browser/OS if relevant, and a | ||||
| [screenshot or screenGIF](https://zulip.readthedocs.io/en/latest/tutorials/screenshot-and-gif-software.html) | ||||
| if appropriate. | ||||
|  | ||||
| **Reporting security issues**. Please do not report security issues | ||||
| publicly, including on public streams on chat.zulip.org. You can | ||||
| email security@zulip.com. We create a CVE for every security | ||||
| issue in our released software. | ||||
|  | ||||
| ## User feedback | ||||
|  | ||||
| @@ -376,54 +243,105 @@ to: | ||||
| - Organization: What does your organization do? How big is the organization? | ||||
|   A link to your organization's website? | ||||
|  | ||||
| You can contact us in the [#feedback stream of the Zulip development | ||||
| community](https://chat.zulip.org/#narrow/channel/137-feedback) or | ||||
| by emailing [support@zulip.com](mailto:support@zulip.com). | ||||
|  | ||||
| ## Outreach programs | ||||
|  | ||||
| Zulip regularly participates in [Google Summer of Code | ||||
| (GSoC)](https://developers.google.com/open-source/gsoc/) and | ||||
| [Outreachy](https://www.outreachy.org/). We have been a GSoC mentoring | ||||
| organization since 2016, and we accept 15-20 GSoC participants each summer. In | ||||
| the past, we’ve also participated in [Google | ||||
| Code-In](https://developers.google.com/open-source/gci/), and hosted summer | ||||
| interns from Harvard, MIT, and Stanford. | ||||
| Zulip participates in [Google Summer of Code | ||||
| (GSoC)](https://developers.google.com/open-source/gsoc/) every year. | ||||
| In the past, we've also participated in | ||||
| [Outreachy](https://www.outreachy.org/), [Google | ||||
| Code-In](https://developers.google.com/open-source/gci/), and hosted | ||||
| summer interns from Harvard, MIT, and Stanford. | ||||
|  | ||||
| Check out our [outreach programs | ||||
| overview](https://zulip.readthedocs.io/en/latest/outreach/overview.html) to learn | ||||
| more about participating in an outreach program with Zulip. Most of our program | ||||
| participants end up sticking around the project long-term, and many have become | ||||
| core team members, maintaining important parts of the project. We hope you | ||||
| apply! | ||||
| While each third-party program has its own rules and requirements, the | ||||
| Zulip community's approaches all of these programs with these ideas in | ||||
| mind: | ||||
|  | ||||
| ## Stay connected | ||||
| - We try to make the application process as valuable for the applicant as | ||||
|   possible. Expect high-quality code reviews, a supportive community, and | ||||
|   publicly viewable patches you can link to from your resume, regardless of | ||||
|   whether you are selected. | ||||
| - To apply, you'll have to submit at least one pull request to a Zulip | ||||
|   repository. Most students accepted to one of our programs have | ||||
|   several merged pull requests (including at least one larger PR) by | ||||
|   the time of the application deadline. | ||||
| - The main criteria we use is quality of your best contributions, and | ||||
|   the bullets listed at | ||||
|   [What makes a great Zulip contributor](#what-makes-a-great-zulip-contributor). | ||||
|   Because we focus on evaluating your best work, it doesn't hurt your | ||||
|   application to makes mistakes in your first few PRs as long as your | ||||
|   work improves. | ||||
|  | ||||
| Even if you are not logging into the development community on a regular basis, | ||||
| you can still stay connected with the project. | ||||
| Most of our outreach program participants end up sticking around the | ||||
| project long-term, and many have become core team members, maintaining | ||||
| important parts of the project. We hope you apply! | ||||
|  | ||||
| - Follow us [on Twitter](https://twitter.com/zulip). | ||||
| - Subscribe to [our blog](https://blog.zulip.org/). | ||||
| - Join or follow the project [on LinkedIn](https://www.linkedin.com/company/zulip-project/). | ||||
| ### Google Summer of Code | ||||
|  | ||||
| ## Help others find Zulip | ||||
| The largest outreach program Zulip participates in is GSoC (14 | ||||
| students in 2017; 11 in 2018; 17 in 2019; 18 in 2020). While we don't control how | ||||
| many slots Google allocates to Zulip, we hope to mentor a similar | ||||
| number of students in future summers. | ||||
|  | ||||
| Here are some ways you can help others find Zulip: | ||||
| If you're reading this well before the application deadline and want | ||||
| to make your application strong, we recommend getting involved in the | ||||
| community and fixing issues in Zulip now. Having good contributions | ||||
| and building a reputation for doing good work is the best way to have | ||||
| a strong application. About half of Zulip's GSoC students for Summer | ||||
| 2017 had made significant contributions to the project by February | ||||
| 2017, and about half had not. Our | ||||
| [GSoC project ideas page][gsoc-guide] has lots more details on how | ||||
| Zulip does GSoC, as well as project ideas (though the project idea | ||||
| list is maintained only during the GSoC application period, so if | ||||
| you're looking at some other time of year, the project list is likely | ||||
| out-of-date). | ||||
|  | ||||
| We also have in some past years run a Zulip Summer of Code (ZSoC) | ||||
| program for students who we didn't have enough slots to accept for | ||||
| GSoC but were able to find funding for. Student expectations are the | ||||
| same as with GSoC, and it has no separate application process; your | ||||
| GSoC application is your ZSoC application. If we'd like to select you | ||||
| for ZSoC, we'll contact you when the GSoC results are announced. | ||||
|  | ||||
| [gsoc-guide]: https://zulip.readthedocs.io/en/latest/contributing/gsoc-ideas.html | ||||
| [gsoc-faq]: https://developers.google.com/open-source/gsoc/faq | ||||
|  | ||||
| ## Zulip outreach | ||||
|  | ||||
| **Upvoting Zulip**. Upvotes and reviews make a big difference in the public | ||||
| perception of projects like Zulip. We've collected a few sites below | ||||
| where we know Zulip has been discussed. Doing everything in the following | ||||
| list typically takes about 15 minutes. | ||||
|  | ||||
| - Star us on GitHub. There are four main repositories: | ||||
|   [server/web](https://github.com/zulip/zulip), | ||||
|   [Flutter mobile](https://github.com/zulip/zulip-flutter), | ||||
|   [mobile](https://github.com/zulip/zulip-mobile), | ||||
|   [desktop](https://github.com/zulip/zulip-desktop), and | ||||
|   [Python API](https://github.com/zulip/python-zulip-api). | ||||
| - [Follow us](https://twitter.com/zulip) on Twitter. | ||||
|  | ||||
| - "Like" and retweet [our tweets](https://twitter.com/zulip). | ||||
| For both of the following, you'll need to make an account on the site if you | ||||
| don't already have one. | ||||
|  | ||||
| - Upvote and post feedback on Zulip on comparison websites. A couple specific | ||||
|   ones to highlight: | ||||
|  | ||||
|   - [AlternativeTo](https://alternativeto.net/software/zulip-chat-server/). You can also | ||||
| - [Like Zulip](https://alternativeto.net/software/zulip-chat-server/) on | ||||
|   AlternativeTo. We recommend upvoting a couple of other products you like | ||||
|   as well, both to give back to their community, and since single-upvote | ||||
|   accounts are generally given less weight. You can also | ||||
|   [upvote Zulip](https://alternativeto.net/software/slack/) on their page | ||||
|   for Slack. | ||||
| - [Add Zulip to your stack](https://stackshare.io/zulip) on StackShare, star | ||||
|   it, and upvote the reasons why people like Zulip that you find most | ||||
|     compelling. | ||||
|   compelling. Again, we recommend adding a few other products that you like | ||||
|   as well. | ||||
|  | ||||
| We have a doc with more detailed instructions and a few other sites, if you | ||||
| have been using Zulip for a while and want to contribute more. | ||||
|  | ||||
| **Blog posts**. Writing a blog post about your experiences with Zulip, or | ||||
| about a technical aspect of Zulip can be a great way to spread the word | ||||
| about Zulip. | ||||
|  | ||||
| We also occasionally [publish](https://blog.zulip.org/) long-form | ||||
| articles related to Zulip. Our posts typically get tens of thousands | ||||
| of views, and we always have good ideas for blog posts that we can | ||||
| outline but don't have time to write. If you are an experienced writer | ||||
| or copyeditor, send us a portfolio; we'd love to talk! | ||||
|   | ||||
| @@ -1,23 +1,13 @@ | ||||
| # This is a multiarch Dockerfile.  See https://docs.docker.com/desktop/multi-arch/ | ||||
| # | ||||
| # To set up the first time: | ||||
| #     docker buildx create --name multiarch --use | ||||
| # | ||||
| # To build: | ||||
| #     docker buildx build --platform linux/amd64,linux/arm64 \ | ||||
| #       -f ./Dockerfile-postgresql -t zulip/zulip-postgresql:14 --push . | ||||
| # To build run `docker build -f Dockerfile-postgresql .` from the root of the | ||||
| # zulip repo. | ||||
|  | ||||
| # Currently the PostgreSQL images do not support automatic upgrading of | ||||
| # the on-disk data in volumes. So the base image can not currently be upgraded | ||||
| # without users needing a manual pgdump and restore. | ||||
|  | ||||
| # https://hub.docker.com/r/groonga/pgroonga/tags | ||||
| ARG PGROONGA_VERSION=latest | ||||
| ARG POSTGRESQL_VERSION=14 | ||||
| FROM groonga/pgroonga:$PGROONGA_VERSION-alpine-$POSTGRESQL_VERSION-slim | ||||
|  | ||||
| # Install hunspell, Zulip stop words, and run Zulip database | ||||
| # init. | ||||
| FROM groonga/pgroonga:latest-alpine-10-slim | ||||
| RUN apk add -U --no-cache hunspell-en | ||||
| RUN ln -sf /usr/share/hunspell/en_US.dic /usr/local/share/postgresql/tsearch_data/en_us.dict && ln -sf /usr/share/hunspell/en_US.aff /usr/local/share/postgresql/tsearch_data/en_us.affix  | ||||
| COPY puppet/zulip/files/postgresql/zulip_english.stop /usr/local/share/postgresql/tsearch_data/zulip_english.stop | ||||
|   | ||||
							
								
								
									
										110
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										110
									
								
								README.md
									
									
									
									
									
								
							| @@ -1,23 +1,17 @@ | ||||
| # Zulip overview | ||||
|  | ||||
| [Zulip](https://zulip.com) is an open-source team collaboration tool with unique | ||||
| [topic-based threading][why-zulip] that combines the best of email and chat to | ||||
| make remote work productive and delightful. Fortune 500 companies, [leading open | ||||
| source projects][rust-case-study], and thousands of other organizations use | ||||
| Zulip every day. Zulip is the only [modern team chat app][features] that is | ||||
| designed for both live and asynchronous conversations. | ||||
|  | ||||
| Zulip is built by a distributed community of developers from all around the | ||||
| world, with 74+ people who have each contributed 100+ commits. With | ||||
| over 1000 contributors merging over 500 commits a month, Zulip is the | ||||
| largest and fastest growing open source team chat project. | ||||
|  | ||||
| Come find us on the [development community chat](https://zulip.com/development-community/)! | ||||
| Zulip is a powerful, open source group chat application that combines the | ||||
| immediacy of real-time chat with the productivity benefits of threaded | ||||
| conversations. Zulip is used by open source projects, Fortune 500 companies, | ||||
| large standards bodies, and others who need a real-time chat system that | ||||
| allows users to easily process hundreds or thousands of messages a day. With | ||||
| over 700 contributors merging over 500 commits a month, Zulip is also the | ||||
| largest and fastest growing open source group chat project. | ||||
|  | ||||
| [](https://github.com/zulip/zulip/actions/workflows/zulip-ci.yml?query=branch%3Amain) | ||||
| [](https://codecov.io/gh/zulip/zulip) | ||||
| [][mypy-coverage] | ||||
| [](https://github.com/astral-sh/ruff) | ||||
| [](https://github.com/psf/black) | ||||
| [](https://github.com/prettier/prettier) | ||||
| [](https://github.com/zulip/zulip/releases/latest) | ||||
| [](https://zulip.readthedocs.io/en/latest/) | ||||
| @@ -26,57 +20,61 @@ Come find us on the [development community chat](https://zulip.com/development-c | ||||
| [](https://github.com/sponsors/zulip) | ||||
|  | ||||
| [mypy-coverage]: https://blog.zulip.org/2016/10/13/static-types-in-python-oh-mypy/ | ||||
| [why-zulip]: https://zulip.com/why-zulip/ | ||||
| [rust-case-study]: https://zulip.com/case-studies/rust/ | ||||
| [features]: https://zulip.com/features/ | ||||
|  | ||||
| ## Getting started | ||||
|  | ||||
| - **Contributing code**. Check out our [guide for new | ||||
|   contributors](https://zulip.readthedocs.io/en/latest/contributing/contributing.html) | ||||
|   to get started. We have invested in making Zulip’s code highly | ||||
|   readable, thoughtfully tested, and easy to modify. Beyond that, we | ||||
|   have written an extraordinary 150K words of documentation for Zulip | ||||
|   contributors. | ||||
| Click on the appropriate link below. If nothing seems to apply, | ||||
| join us on the | ||||
| [Zulip community server](https://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html) | ||||
| and tell us what's up! | ||||
|  | ||||
| - **Contributing non-code**. [Report an | ||||
|   issue](https://zulip.readthedocs.io/en/latest/contributing/contributing.html#reporting-issues), | ||||
|   [translate](https://zulip.readthedocs.io/en/latest/translating/translating.html) | ||||
|   Zulip into your language, or [give us | ||||
|   feedback](https://zulip.readthedocs.io/en/latest/contributing/contributing.html#user-feedback). | ||||
|   We'd love to hear from you, whether you've been using Zulip for years, or are just | ||||
|   trying it out for the first time. | ||||
| You might be interested in: | ||||
|  | ||||
| - **Checking Zulip out**. The best way to see Zulip in action is to drop by the | ||||
|   [Zulip community server](https://zulip.com/development-community/). We also | ||||
|   recommend reading about Zulip's [unique | ||||
|   approach](https://zulip.com/why-zulip/) to organizing conversations. | ||||
| - **Contributing code**. Check out our | ||||
|   [guide for new contributors](https://zulip.readthedocs.io/en/latest/overview/contributing.html) | ||||
|   to get started. Zulip prides itself on maintaining a clean and | ||||
|   well-tested codebase, and a stock of hundreds of | ||||
|   [beginner-friendly issues][beginner-friendly]. | ||||
|  | ||||
| - **Running a Zulip server**. Self-host Zulip directly on Ubuntu or Debian | ||||
|   Linux, in [Docker](https://github.com/zulip/docker-zulip), or with prebuilt | ||||
|   images for [Digital Ocean](https://marketplace.digitalocean.com/apps/zulip) and | ||||
|   [Render](https://render.com/docs/deploy-zulip). | ||||
|   Learn more about [self-hosting Zulip](https://zulip.com/self-hosting/). | ||||
| - **Contributing non-code**. | ||||
|   [Report an issue](https://zulip.readthedocs.io/en/latest/overview/contributing.html#reporting-issues), | ||||
|   [translate](https://zulip.readthedocs.io/en/latest/translating/translating.html) Zulip | ||||
|   into your language, | ||||
|   [write](https://zulip.readthedocs.io/en/latest/overview/contributing.html#zulip-outreach) | ||||
|   for the Zulip blog, or | ||||
|   [give us feedback](https://zulip.readthedocs.io/en/latest/overview/contributing.html#user-feedback). We | ||||
|   would love to hear from you, even if you're just trying the product out. | ||||
|  | ||||
| - **Using Zulip without setting up a server**. Learn about [Zulip | ||||
|   Cloud](https://zulip.com/plans/) hosting options. Zulip sponsors free [Zulip | ||||
|   Cloud Standard](https://zulip.com/plans/) for hundreds of worthy | ||||
|   organizations, including [fellow open-source | ||||
|   projects](https://zulip.com/for/open-source/). | ||||
| - **Supporting Zulip**. Advocate for your organization to use Zulip, become a [sponsor](https://github.com/sponsors/zulip), write a | ||||
|   review in the mobile app stores, or | ||||
|   [upvote Zulip](https://zulip.readthedocs.io/en/latest/overview/contributing.html#zulip-outreach) on | ||||
|   product comparison sites. | ||||
|  | ||||
| - **Checking Zulip out**. The best way to see Zulip in action is to drop by | ||||
|   the | ||||
|   [Zulip community server](https://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html). We | ||||
|   also recommend reading Zulip for | ||||
|   [open source](https://zulip.com/for/open-source/), Zulip for | ||||
|   [companies](https://zulip.com/for/companies/), or Zulip for | ||||
|   [working groups and part time communities](https://zulip.com/for/working-groups-and-communities/). | ||||
|  | ||||
| - **Running a Zulip server**. Use a preconfigured [DigitalOcean droplet](https://marketplace.digitalocean.com/apps/zulip), | ||||
|   [install Zulip](https://zulip.readthedocs.io/en/stable/production/install.html) | ||||
|   directly, or use Zulip's | ||||
|   experimental [Docker image](https://zulip.readthedocs.io/en/latest/production/deployment.html#zulip-in-docker). | ||||
|   Commercial support is available; see <https://zulip.com/plans> for details. | ||||
|  | ||||
| - **Using Zulip without setting up a server**. <https://zulip.com> | ||||
|   offers free and commercial hosting, including providing our paid | ||||
|   plan for free to fellow open source projects. | ||||
|  | ||||
| - **Participating in [outreach | ||||
|   programs](https://zulip.readthedocs.io/en/latest/contributing/contributing.html#outreach-programs)** | ||||
|   like [Google Summer of Code](https://developers.google.com/open-source/gsoc/) | ||||
|   and [Outreachy](https://www.outreachy.org/). | ||||
|  | ||||
| - **Supporting Zulip**. Advocate for your organization to use Zulip, become a | ||||
|   [sponsor](https://github.com/sponsors/zulip), write a review in the mobile app | ||||
|   stores, or [help others find | ||||
|   Zulip](https://zulip.readthedocs.io/en/latest/contributing/contributing.html#help-others-find-zulip). | ||||
|  | ||||
| You may also be interested in reading our [blog](https://blog.zulip.org/), and | ||||
| following us on [Twitter](https://twitter.com/zulip) and | ||||
| [LinkedIn](https://www.linkedin.com/company/zulip-project/). | ||||
|   programs](https://zulip.readthedocs.io/en/latest/overview/contributing.html#outreach-programs)** | ||||
|   like Google Summer of Code. | ||||
|  | ||||
| You may also be interested in reading our [blog](https://blog.zulip.org/) or | ||||
| following us on [Twitter](https://twitter.com/zulip). | ||||
| Zulip is distributed under the | ||||
| [Apache 2.0](https://github.com/zulip/zulip/blob/main/LICENSE) license. | ||||
|  | ||||
| [beginner-friendly]: https://github.com/zulip/zulip/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22 | ||||
|   | ||||
							
								
								
									
										17
									
								
								SECURITY.md
									
									
									
									
									
								
							
							
						
						
									
										17
									
								
								SECURITY.md
									
									
									
									
									
								
							| @@ -1,5 +1,8 @@ | ||||
| # Security policy | ||||
|  | ||||
| Security announcements are sent to zulip-announce@googlegroups.com, | ||||
| so you should subscribe if you are running Zulip in production. | ||||
|  | ||||
| ## Reporting a vulnerability | ||||
|  | ||||
| We love responsible reports of (potential) security issues in Zulip, | ||||
| @@ -14,13 +17,6 @@ in our release notes when we publish the fix. | ||||
| Our [security model][security-model] document may be a helpful | ||||
| resource. | ||||
|  | ||||
| ## Security announcements | ||||
|  | ||||
| We send security announcements to our [announcement mailing | ||||
| list](https://groups.google.com/g/zulip-announce). If you are running | ||||
| Zulip in production, you should subscribe, by clicking "Join group" at | ||||
| the top of that page. | ||||
|  | ||||
| ## Supported versions | ||||
|  | ||||
| Zulip provides security support for the latest major release, in the | ||||
| @@ -29,9 +25,8 @@ form of minor security/maintenance releases. | ||||
| We work hard to make [upgrades][upgrades] reliable, so that there's no | ||||
| reason to run older major releases. | ||||
|  | ||||
| See also our documentation on the [Zulip release | ||||
| lifecycle][release-lifecycle]. | ||||
| See also our documentation on the [Zulip release lifecycle][release-lifecycle] | ||||
|  | ||||
| [security-model]: https://zulip.readthedocs.io/en/latest/production/security-model.html | ||||
| [upgrades]: https://zulip.readthedocs.io/en/stable/production/upgrade.html#upgrading-to-a-release | ||||
| [release-lifecycle]: https://zulip.readthedocs.io/en/latest/overview/release-lifecycle.html | ||||
| [upgrades]: https://zulip.readthedocs.io/en/latest/production/upgrade-or-modify.html#upgrading-to-a-release | ||||
| [release-cycle]: https://zulip.readthedocs.io/en/latest/overview/release-lifecycle.html | ||||
|   | ||||
							
								
								
									
										112
									
								
								Vagrantfile
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										112
									
								
								Vagrantfile
									
									
									
									
										vendored
									
									
								
							| @@ -1,8 +1,48 @@ | ||||
| # -*- mode: ruby -*- | ||||
|  | ||||
| Vagrant.require_version ">= 2.2.6" | ||||
| VAGRANTFILE_API_VERSION = "2" | ||||
|  | ||||
| if Vagrant::VERSION == "1.8.7" | ||||
|   path = `command -v curl` | ||||
|   if path.include?("/opt/vagrant/embedded/bin/curl") | ||||
|     puts "In Vagrant 1.8.7, curl is broken. Please use Vagrant 2.0.2 " \ | ||||
|          "or run 'sudo rm -f /opt/vagrant/embedded/bin/curl' to fix the " \ | ||||
|          "issue before provisioning. See " \ | ||||
|          "https://github.com/mitchellh/vagrant/issues/7997 " \ | ||||
|          "for reference." | ||||
|     exit | ||||
|   end | ||||
| end | ||||
|  | ||||
| # Workaround: Vagrant removed the atlas.hashicorp.com to | ||||
| # vagrantcloud.com redirect in February 2018. The value of | ||||
| # DEFAULT_SERVER_URL in Vagrant versions less than 1.9.3 is | ||||
| # atlas.hashicorp.com, which means that removal broke the fetching and | ||||
| # updating of boxes (since the old URL doesn't work).  See | ||||
| # https://github.com/hashicorp/vagrant/issues/9442 | ||||
| if Vagrant::DEFAULT_SERVER_URL == "atlas.hashicorp.com" | ||||
|   Vagrant::DEFAULT_SERVER_URL.replace("https://vagrantcloud.com") | ||||
| end | ||||
|  | ||||
| # Monkey patch https://github.com/hashicorp/vagrant/pull/10879 so we | ||||
| # can fall back to another provider if docker is not installed. | ||||
| begin | ||||
|   require Vagrant.source_root.join("plugins", "providers", "docker", "provider") | ||||
| rescue LoadError | ||||
| else | ||||
|   VagrantPlugins::DockerProvider::Provider.class_eval do | ||||
|     method(:usable?).owner == singleton_class or def self.usable?(raise_error = false) | ||||
|       VagrantPlugins::DockerProvider::Driver.new.execute("docker", "version") | ||||
|       true | ||||
|     rescue Vagrant::Errors::CommandUnavailable, VagrantPlugins::DockerProvider::Errors::ExecuteError | ||||
|       raise if raise_error | ||||
|       return false | ||||
|     end | ||||
|   end | ||||
| end | ||||
|  | ||||
| Vagrant.configure(VAGRANTFILE_API_VERSION) do |config| | ||||
|  | ||||
| Vagrant.configure("2") do |config| | ||||
|   # The Zulip development environment runs on 9991 on the guest. | ||||
|   host_port = 9991 | ||||
|   http_proxy = https_proxy = no_proxy = nil | ||||
| @@ -15,10 +55,8 @@ Vagrant.configure("2") do |config| | ||||
|   ubuntu_mirror = "" | ||||
|   vboxadd_version = nil | ||||
|  | ||||
|   config.vm.box = "bento/ubuntu-22.04" | ||||
|  | ||||
|   config.vm.synced_folder ".", "/vagrant", disabled: true | ||||
|   config.vm.synced_folder ".", "/srv/zulip", docker_consistency: "z" | ||||
|   config.vm.synced_folder ".", "/srv/zulip" | ||||
|  | ||||
|   vagrant_config_file = ENV["HOME"] + "/.zulip-vagrant-config" | ||||
|   if File.file?(vagrant_config_file) | ||||
| @@ -63,7 +101,6 @@ Vagrant.configure("2") do |config| | ||||
|   config.vm.network "forwarded_port", guest: 9994, host: host_port + 3, host_ip: host_ip_addr | ||||
|   # Specify Docker provider before VirtualBox provider so it's preferred. | ||||
|   config.vm.provider "docker" do |d, override| | ||||
|     override.vm.box = nil | ||||
|     d.build_dir = File.join(__dir__, "tools", "setup", "dev-vagrant-docker") | ||||
|     d.build_args = ["--build-arg", "VAGRANT_UID=#{Process.uid}"] | ||||
|     if !ubuntu_mirror.empty? | ||||
| @@ -74,6 +111,7 @@ Vagrant.configure("2") do |config| | ||||
|   end | ||||
|  | ||||
|   config.vm.provider "virtualbox" do |vb, override| | ||||
|     override.vm.box = "hashicorp/bionic64" | ||||
|     # It's possible we can get away with just 1.5GB; more testing needed | ||||
|     vb.memory = vm_memory | ||||
|     vb.cpus = vm_num_cpus | ||||
| @@ -90,19 +128,77 @@ Vagrant.configure("2") do |config| | ||||
|   end | ||||
|  | ||||
|   config.vm.provider "hyperv" do |h, override| | ||||
|     override.vm.box = "bento/ubuntu-18.04" | ||||
|     h.memory = vm_memory | ||||
|     h.maxmemory = vm_memory | ||||
|     h.cpus = vm_num_cpus | ||||
|   end | ||||
|  | ||||
|   config.vm.provider "parallels" do |prl, override| | ||||
|     override.vm.box = "bento/ubuntu-18.04" | ||||
|     override.vm.box_version = "202005.21.0" | ||||
|     prl.memory = vm_memory | ||||
|     prl.cpus = vm_num_cpus | ||||
|   end | ||||
|  | ||||
|   $provision_script = <<SCRIPT | ||||
| set -x | ||||
| set -e | ||||
| set -o pipefail | ||||
|  | ||||
| # Code should go here, rather than tools/provision, only if it is | ||||
| # something that we don't want to happen when running provision in a | ||||
| # development environment not using Vagrant. | ||||
|  | ||||
| # Set the Ubuntu mirror | ||||
| [ ! '#{ubuntu_mirror}' ] || sudo sed -i 's|http://\\(\\w*\\.\\)*archive\\.ubuntu\\.com/ubuntu/\\? |#{ubuntu_mirror} |' /etc/apt/sources.list | ||||
|  | ||||
| # Set the MOTD on the system to have Zulip instructions | ||||
| sudo ln -nsf /srv/zulip/tools/setup/dev-motd /etc/update-motd.d/99-zulip-dev | ||||
| sudo rm -f /etc/update-motd.d/10-help-text | ||||
| sudo dpkg --purge landscape-client landscape-common ubuntu-release-upgrader-core update-manager-core update-notifier-common ubuntu-server | ||||
| sudo dpkg-divert --add --rename /etc/default/motd-news | ||||
| sudo sh -c 'echo ENABLED=0 > /etc/default/motd-news' | ||||
|  | ||||
| # Set default locale, this prevents errors if the user has another locale set. | ||||
| if ! grep -q 'LC_ALL=C.UTF-8' /etc/default/locale; then | ||||
|     echo "LC_ALL=C.UTF-8" | sudo tee -a /etc/default/locale | ||||
| fi | ||||
|  | ||||
| # Set an environment variable, so that we won't print the virtualenv | ||||
| # shell warning (it'll be wrong, since the shell is dying anyway) | ||||
| export SKIP_VENV_SHELL_WARNING=1 | ||||
|  | ||||
| # End `set -x`, so that the end of provision doesn't look like an error | ||||
| # message after a successful run. | ||||
| set +x | ||||
|  | ||||
| # Check if the zulip directory is writable | ||||
| if [ ! -w /srv/zulip ]; then | ||||
|     echo "The vagrant user is unable to write to the zulip directory." | ||||
|     echo "To fix this, run the following commands on the host machine:" | ||||
|     # sudo is required since our uid is not 1000 | ||||
|     echo '    vagrant halt -f' | ||||
|     echo '    rm -rf /PATH/TO/ZULIP/CLONE/.vagrant' | ||||
|     echo '    sudo chown -R 1000:$(id -g) /PATH/TO/ZULIP/CLONE' | ||||
|     echo "Replace /PATH/TO/ZULIP/CLONE with the path to where zulip code is cloned." | ||||
|     echo "You can resume setting up your vagrant environment by running:" | ||||
|     echo "    vagrant up" | ||||
|     exit 1 | ||||
| fi | ||||
| # Provision the development environment | ||||
| ln -nsf /srv/zulip ~/zulip | ||||
| /srv/zulip/tools/provision | ||||
|  | ||||
| # Run any custom provision hooks the user has configured | ||||
| if [ -f /srv/zulip/tools/custom_provision ]; then | ||||
|     chmod +x /srv/zulip/tools/custom_provision | ||||
|     /srv/zulip/tools/custom_provision | ||||
| fi | ||||
| SCRIPT | ||||
|  | ||||
|   config.vm.provision "shell", | ||||
|     # We want provision to be run with the permissions of the vagrant user. | ||||
|     privileged: false, | ||||
|     path: "tools/setup/vagrant-provision", | ||||
|     env: { "UBUNTU_MIRROR" => ubuntu_mirror } | ||||
|     inline: $provision_script | ||||
| end | ||||
|   | ||||
| @@ -1,14 +1,13 @@ | ||||
| import logging | ||||
| import time | ||||
| from collections import OrderedDict, defaultdict | ||||
| from collections.abc import Callable, Sequence | ||||
| from datetime import datetime, timedelta | ||||
| from typing import TypeAlias, Union | ||||
| from typing import Callable, Dict, Optional, Sequence, Tuple, Type, Union | ||||
|  | ||||
| from django.conf import settings | ||||
| from django.db import connection, models | ||||
| from django.db import connection | ||||
| from django.db.models import F | ||||
| from psycopg2.sql import SQL, Composable, Identifier, Literal | ||||
| from typing_extensions import override | ||||
|  | ||||
| from analytics.models import ( | ||||
|     BaseCount, | ||||
| @@ -19,20 +18,22 @@ from analytics.models import ( | ||||
|     UserCount, | ||||
|     installation_epoch, | ||||
| ) | ||||
| from zerver.lib.logging_util import log_to_file | ||||
| from zerver.lib.timestamp import ceiling_to_day, ceiling_to_hour, floor_to_hour, verify_UTC | ||||
| from zerver.models import Message, Realm, RealmAuditLog, Stream, UserActivityInterval, UserProfile | ||||
|  | ||||
| if settings.ZILENCER_ENABLED: | ||||
|     from zilencer.models import ( | ||||
|         RemoteInstallationCount, | ||||
|         RemoteRealm, | ||||
|         RemoteRealmCount, | ||||
|         RemoteZulipServer, | ||||
| from zerver.models import ( | ||||
|     Message, | ||||
|     Realm, | ||||
|     RealmAuditLog, | ||||
|     Stream, | ||||
|     UserActivityInterval, | ||||
|     UserProfile, | ||||
|     models, | ||||
| ) | ||||
|  | ||||
| ## Logging setup ## | ||||
|  | ||||
| logger = logging.getLogger("zulip.analytics") | ||||
|  | ||||
| logger = logging.getLogger("zulip.management") | ||||
| log_to_file(logger, settings.ANALYTICS_LOG_PATH) | ||||
|  | ||||
| # You can't subtract timedelta.max from a datetime, so use this instead | ||||
| TIMEDELTA_MAX = timedelta(days=365 * 1000) | ||||
| @@ -56,7 +57,7 @@ class CountStat: | ||||
|         property: str, | ||||
|         data_collector: "DataCollector", | ||||
|         frequency: str, | ||||
|         interval: timedelta | None = None, | ||||
|         interval: Optional[timedelta] = None, | ||||
|     ) -> None: | ||||
|         self.property = property | ||||
|         self.data_collector = data_collector | ||||
| @@ -69,11 +70,10 @@ class CountStat: | ||||
|         else: | ||||
|             self.interval = self.time_increment | ||||
|  | ||||
|     @override | ||||
|     def __repr__(self) -> str: | ||||
|     def __str__(self) -> str: | ||||
|         return f"<CountStat: {self.property}>" | ||||
|  | ||||
|     def last_successful_fill(self) -> datetime | None: | ||||
|     def last_successful_fill(self) -> Optional[datetime]: | ||||
|         fillstate = FillState.objects.filter(property=self.property).first() | ||||
|         if fillstate is None: | ||||
|             return None | ||||
| @@ -83,7 +83,7 @@ class CountStat: | ||||
|  | ||||
|  | ||||
| class LoggingCountStat(CountStat): | ||||
|     def __init__(self, property: str, output_table: type[BaseCount], frequency: str) -> None: | ||||
|     def __init__(self, property: str, output_table: Type[BaseCount], frequency: str) -> None: | ||||
|         CountStat.__init__(self, property, DataCollector(output_table, None), frequency) | ||||
|  | ||||
|  | ||||
| @@ -93,7 +93,7 @@ class DependentCountStat(CountStat): | ||||
|         property: str, | ||||
|         data_collector: "DataCollector", | ||||
|         frequency: str, | ||||
|         interval: timedelta | None = None, | ||||
|         interval: Optional[timedelta] = None, | ||||
|         dependencies: Sequence[str] = [], | ||||
|     ) -> None: | ||||
|         CountStat.__init__(self, property, data_collector, frequency, interval=interval) | ||||
| @@ -103,20 +103,19 @@ class DependentCountStat(CountStat): | ||||
| class DataCollector: | ||||
|     def __init__( | ||||
|         self, | ||||
|         output_table: type[BaseCount], | ||||
|         pull_function: Callable[[str, datetime, datetime, Realm | None], int] | None, | ||||
|         output_table: Type[BaseCount], | ||||
|         pull_function: Optional[Callable[[str, datetime, datetime, Optional[Realm]], int]], | ||||
|     ) -> None: | ||||
|         self.output_table = output_table | ||||
|         self.pull_function = pull_function | ||||
|  | ||||
|     def depends_on_realm(self) -> bool: | ||||
|         return self.output_table in (UserCount, StreamCount) | ||||
|  | ||||
|  | ||||
| ## CountStat-level operations ## | ||||
|  | ||||
|  | ||||
| def process_count_stat(stat: CountStat, fill_to_time: datetime, realm: Realm | None = None) -> None: | ||||
| def process_count_stat( | ||||
|     stat: CountStat, fill_to_time: datetime, realm: Optional[Realm] = None | ||||
| ) -> None: | ||||
|     # TODO: The realm argument is not yet supported, in that we don't | ||||
|     # have a solution for how to update FillState if it is passed.  It | ||||
|     # exists solely as partial plumbing for when we do fully implement | ||||
| @@ -158,7 +157,7 @@ def process_count_stat(stat: CountStat, fill_to_time: datetime, realm: Realm | N | ||||
|                 return | ||||
|             fill_to_time = min(fill_to_time, dependency_fill_time) | ||||
|  | ||||
|     currently_filled += stat.time_increment | ||||
|     currently_filled = currently_filled + stat.time_increment | ||||
|     while currently_filled <= fill_to_time: | ||||
|         logger.info("START %s %s", stat.property, currently_filled) | ||||
|         start = time.time() | ||||
| @@ -166,7 +165,7 @@ def process_count_stat(stat: CountStat, fill_to_time: datetime, realm: Realm | N | ||||
|         do_fill_count_stat_at_hour(stat, currently_filled, realm) | ||||
|         do_update_fill_state(fill_state, currently_filled, FillState.DONE) | ||||
|         end = time.time() | ||||
|         currently_filled += stat.time_increment | ||||
|         currently_filled = currently_filled + stat.time_increment | ||||
|         logger.info("DONE %s (%dms)", stat.property, (end - start) * 1000) | ||||
|  | ||||
|  | ||||
| @@ -177,9 +176,9 @@ def do_update_fill_state(fill_state: FillState, end_time: datetime, state: int) | ||||
|  | ||||
|  | ||||
| # We assume end_time is valid (e.g. is on a day or hour boundary as appropriate) | ||||
| # and is time-zone-aware. It is the caller's responsibility to enforce this! | ||||
| # and is timezone aware. It is the caller's responsibility to enforce this! | ||||
| def do_fill_count_stat_at_hour( | ||||
|     stat: CountStat, end_time: datetime, realm: Realm | None = None | ||||
|     stat: CountStat, end_time: datetime, realm: Optional[Realm] = None | ||||
| ) -> None: | ||||
|     start_time = end_time - stat.interval | ||||
|     if not isinstance(stat, LoggingCountStat): | ||||
| @@ -198,7 +197,7 @@ def do_fill_count_stat_at_hour( | ||||
| def do_delete_counts_at_hour(stat: CountStat, end_time: datetime) -> None: | ||||
|     if isinstance(stat, LoggingCountStat): | ||||
|         InstallationCount.objects.filter(property=stat.property, end_time=end_time).delete() | ||||
|         if stat.data_collector.depends_on_realm(): | ||||
|         if stat.data_collector.output_table in [UserCount, StreamCount]: | ||||
|             RealmCount.objects.filter(property=stat.property, end_time=end_time).delete() | ||||
|     else: | ||||
|         UserCount.objects.filter(property=stat.property, end_time=end_time).delete() | ||||
| @@ -208,18 +207,18 @@ def do_delete_counts_at_hour(stat: CountStat, end_time: datetime) -> None: | ||||
|  | ||||
|  | ||||
| def do_aggregate_to_summary_table( | ||||
|     stat: CountStat, end_time: datetime, realm: Realm | None = None | ||||
|     stat: CountStat, end_time: datetime, realm: Optional[Realm] = None | ||||
| ) -> None: | ||||
|     cursor = connection.cursor() | ||||
|  | ||||
|     # Aggregate into RealmCount | ||||
|     output_table = stat.data_collector.output_table | ||||
|     if realm is not None: | ||||
|         realm_clause: Composable = SQL("AND zerver_realm.id = {}").format(Literal(realm.id)) | ||||
|         realm_clause = SQL("AND zerver_realm.id = {}").format(Literal(realm.id)) | ||||
|     else: | ||||
|         realm_clause = SQL("") | ||||
|  | ||||
|     if stat.data_collector.depends_on_realm(): | ||||
|     if output_table in (UserCount, StreamCount): | ||||
|         realmcount_query = SQL( | ||||
|             """ | ||||
|             INSERT INTO analytics_realmcount | ||||
| @@ -297,12 +296,11 @@ def do_aggregate_to_summary_table( | ||||
|  | ||||
| ## Utility functions called from outside counts.py ## | ||||
|  | ||||
|  | ||||
| # called from zerver.actions; should not throw any errors | ||||
| # called from zerver/lib/actions.py; should not throw any errors | ||||
| def do_increment_logging_stat( | ||||
|     model_object_for_bucket: Union[Realm, UserProfile, Stream, "RemoteRealm", "RemoteZulipServer"], | ||||
|     zerver_object: Union[Realm, UserProfile, Stream], | ||||
|     stat: CountStat, | ||||
|     subgroup: str | int | bool | None, | ||||
|     subgroup: Optional[Union[str, int, bool]], | ||||
|     event_time: datetime, | ||||
|     increment: int = 1, | ||||
| ) -> None: | ||||
| @@ -310,100 +308,28 @@ def do_increment_logging_stat( | ||||
|         return | ||||
|  | ||||
|     table = stat.data_collector.output_table | ||||
|     id_args: dict[str, int | None] = {} | ||||
|     conflict_args: list[str] = [] | ||||
|     if table == RealmCount: | ||||
|         assert isinstance(model_object_for_bucket, Realm) | ||||
|         id_args = {"realm_id": model_object_for_bucket.id} | ||||
|         conflict_args = ["realm_id"] | ||||
|         id_args = {"realm": zerver_object} | ||||
|     elif table == UserCount: | ||||
|         assert isinstance(model_object_for_bucket, UserProfile) | ||||
|         id_args = { | ||||
|             "realm_id": model_object_for_bucket.realm_id, | ||||
|             "user_id": model_object_for_bucket.id, | ||||
|         } | ||||
|         conflict_args = ["user_id"] | ||||
|     elif table == StreamCount: | ||||
|         assert isinstance(model_object_for_bucket, Stream) | ||||
|         id_args = { | ||||
|             "realm_id": model_object_for_bucket.realm_id, | ||||
|             "stream_id": model_object_for_bucket.id, | ||||
|         } | ||||
|         conflict_args = ["stream_id"] | ||||
|     elif table == RemoteInstallationCount: | ||||
|         assert isinstance(model_object_for_bucket, RemoteZulipServer) | ||||
|         id_args = {"server_id": model_object_for_bucket.id, "remote_id": None} | ||||
|         conflict_args = ["server_id"] | ||||
|     elif table == RemoteRealmCount: | ||||
|         assert isinstance(model_object_for_bucket, RemoteRealm) | ||||
|         # For RemoteRealmCount (e.g. `mobile_pushes_forwarded::day`), | ||||
|         # we have no `remote_id` nor `realm_id`, since they are not | ||||
|         # imported from the remote server, which is the source of | ||||
|         # truth of those two columns.  Their "ON CONFLICT" is thus the | ||||
|         # only unique key we have, which is `remote_realm_id`, and not | ||||
|         # `server_id` / `realm_id`. | ||||
|         id_args = { | ||||
|             "server_id": model_object_for_bucket.server_id, | ||||
|             "remote_realm_id": model_object_for_bucket.id, | ||||
|             "remote_id": None, | ||||
|             "realm_id": None, | ||||
|         } | ||||
|         conflict_args = [ | ||||
|             "remote_realm_id", | ||||
|         ] | ||||
|     else: | ||||
|         raise AssertionError("Unsupported CountStat output_table") | ||||
|         id_args = {"realm": zerver_object.realm, "user": zerver_object} | ||||
|     else:  # StreamCount | ||||
|         id_args = {"realm": zerver_object.realm, "stream": zerver_object} | ||||
|  | ||||
|     if stat.frequency == CountStat.DAY: | ||||
|         end_time = ceiling_to_day(event_time) | ||||
|     elif stat.frequency == CountStat.HOUR: | ||||
|     else:  # CountStat.HOUR: | ||||
|         end_time = ceiling_to_hour(event_time) | ||||
|     else: | ||||
|         raise AssertionError("Unsupported CountStat frequency") | ||||
|  | ||||
|     is_subgroup: SQL = SQL("NULL") | ||||
|     if subgroup is not None: | ||||
|         is_subgroup = SQL("NOT NULL") | ||||
|         # For backwards consistency, we cast the subgroup to a string | ||||
|         # in Python; this emulates the behaviour of `get_or_create`, | ||||
|         # which was previously used in this function, and performed | ||||
|         # this cast because the `subgroup` column is defined as a | ||||
|         # `CharField`.  Omitting this explicit cast causes a subgroup | ||||
|         # of the boolean False to be passed as the PostgreSQL false, | ||||
|         # which it stringifies as the lower-case `'false'`, not the | ||||
|         # initial-case `'False'` if Python stringifies it. | ||||
|         # | ||||
|         # Other parts of the system (e.g. count_message_by_user_query) | ||||
|         # already use PostgreSQL to cast bools to strings, resulting | ||||
|         # in `subgroup` values of lower-case `'false'` -- for example | ||||
|         # in `messages_sent:is_bot:hour`.  Fixing this inconsistency | ||||
|         # via a migration is complicated by these records being | ||||
|         # exchanged over the wire from remote servers. | ||||
|         subgroup = str(subgroup) | ||||
|         conflict_args.append("subgroup") | ||||
|  | ||||
|     id_column_names = SQL(", ").join(map(Identifier, id_args.keys())) | ||||
|     id_values = SQL(", ").join(map(Literal, id_args.values())) | ||||
|     conflict_columns = SQL(", ").join(map(Identifier, conflict_args)) | ||||
|  | ||||
|     sql_query = SQL( | ||||
|         """ | ||||
|         INSERT INTO {table_name}(property, subgroup, end_time, value, {id_column_names}) | ||||
|         VALUES (%s, %s, %s, %s, {id_values}) | ||||
|         ON CONFLICT (property, end_time, {conflict_columns}) | ||||
|         WHERE subgroup IS {is_subgroup} | ||||
|         DO UPDATE SET | ||||
|             value = {table_name}.value + EXCLUDED.value | ||||
|         """ | ||||
|     ).format( | ||||
|         table_name=Identifier(table._meta.db_table), | ||||
|         id_column_names=id_column_names, | ||||
|         id_values=id_values, | ||||
|         conflict_columns=conflict_columns, | ||||
|         is_subgroup=is_subgroup, | ||||
|     row, created = table.objects.get_or_create( | ||||
|         property=stat.property, | ||||
|         subgroup=subgroup, | ||||
|         end_time=end_time, | ||||
|         defaults={"value": increment}, | ||||
|         **id_args, | ||||
|     ) | ||||
|     with connection.cursor() as cursor: | ||||
|         cursor.execute(sql_query, [stat.property, subgroup, end_time, increment]) | ||||
|     if not created: | ||||
|         row.value = F("value") + increment | ||||
|         row.save(update_fields=["value"]) | ||||
|  | ||||
|  | ||||
| def do_drop_all_analytics_tables() -> None: | ||||
| @@ -424,7 +350,7 @@ def do_drop_single_stat(property: str) -> None: | ||||
|  | ||||
| ## DataCollector-level operations ## | ||||
|  | ||||
| QueryFn: TypeAlias = Callable[[dict[str, Composable]], Composable] | ||||
| QueryFn = Callable[[Dict[str, Composable]], Composable] | ||||
|  | ||||
|  | ||||
| def do_pull_by_sql_query( | ||||
| @@ -432,11 +358,11 @@ def do_pull_by_sql_query( | ||||
|     start_time: datetime, | ||||
|     end_time: datetime, | ||||
|     query: QueryFn, | ||||
|     group_by: tuple[type[models.Model], str] | None, | ||||
|     group_by: Optional[Tuple[models.Model, str]], | ||||
| ) -> int: | ||||
|     if group_by is None: | ||||
|         subgroup: Composable = SQL("NULL") | ||||
|         group_by_clause: Composable = SQL("") | ||||
|         subgroup = SQL("NULL") | ||||
|         group_by_clause = SQL("") | ||||
|     else: | ||||
|         subgroup = Identifier(group_by[0]._meta.db_table, group_by[1]) | ||||
|         group_by_clause = SQL(", {}").format(subgroup) | ||||
| @@ -466,12 +392,12 @@ def do_pull_by_sql_query( | ||||
|  | ||||
|  | ||||
| def sql_data_collector( | ||||
|     output_table: type[BaseCount], | ||||
|     output_table: Type[BaseCount], | ||||
|     query: QueryFn, | ||||
|     group_by: tuple[type[models.Model], str] | None, | ||||
|     group_by: Optional[Tuple[models.Model, str]], | ||||
| ) -> DataCollector: | ||||
|     def pull_function( | ||||
|         property: str, start_time: datetime, end_time: datetime, realm: Realm | None = None | ||||
|         property: str, start_time: datetime, end_time: datetime, realm: Optional[Realm] = None | ||||
|     ) -> int: | ||||
|         # The pull function type needs to accept a Realm argument | ||||
|         # because the 'minutes_active::day' CountStat uses | ||||
| @@ -484,42 +410,8 @@ def sql_data_collector( | ||||
|     return DataCollector(output_table, pull_function) | ||||
|  | ||||
|  | ||||
| def count_upload_space_used_by_realm_query(realm: Realm | None) -> QueryFn: | ||||
|     if realm is None: | ||||
|         realm_clause: Composable = SQL("") | ||||
|     else: | ||||
|         realm_clause = SQL("zerver_attachment.realm_id = {} AND").format(Literal(realm.id)) | ||||
|  | ||||
|     # Note: This query currently has to go through the entire table, | ||||
|     # summing all the sizes of attachments for every realm. This can be improved | ||||
|     # by having a query which looks at the latest CountStat for each realm, | ||||
|     # and sums it with only the new attachments. | ||||
|     # There'd be additional complexity added by the fact that attachments can | ||||
|     # also be deleted. Partially this can be accounted for by subtracting | ||||
|     # ArchivedAttachment sizes, but there's still the issue of attachments | ||||
|     # which can be directly deleted via the API. | ||||
|  | ||||
|     return lambda kwargs: SQL( | ||||
|         """ | ||||
|             INSERT INTO analytics_realmcount (realm_id, property, end_time, value) | ||||
|             SELECT | ||||
|                 zerver_attachment.realm_id, | ||||
|                 %(property)s, | ||||
|                 %(time_end)s, | ||||
|                 COALESCE(SUM(zerver_attachment.size), 0) | ||||
|             FROM | ||||
|                 zerver_attachment | ||||
|             WHERE | ||||
|                 {realm_clause} | ||||
|                 zerver_attachment.create_time < %(time_end)s | ||||
|             GROUP BY | ||||
|                 zerver_attachment.realm_id | ||||
|         """ | ||||
|     ).format(**kwargs, realm_clause=realm_clause) | ||||
|  | ||||
|  | ||||
| def do_pull_minutes_active( | ||||
|     property: str, start_time: datetime, end_time: datetime, realm: Realm | None = None | ||||
|     property: str, start_time: datetime, end_time: datetime, realm: Optional[Realm] = None | ||||
| ) -> int: | ||||
|     user_activity_intervals = ( | ||||
|         UserActivityInterval.objects.filter( | ||||
| @@ -532,7 +424,7 @@ def do_pull_minutes_active( | ||||
|         .values_list("user_profile_id", "user_profile__realm_id", "start", "end") | ||||
|     ) | ||||
|  | ||||
|     seconds_active: dict[tuple[int, int], float] = defaultdict(float) | ||||
|     seconds_active: Dict[Tuple[int, int], float] = defaultdict(float) | ||||
|     for user_id, realm_id, interval_start, interval_end in user_activity_intervals: | ||||
|         if realm is None or realm.id == realm_id: | ||||
|             start = max(start_time, interval_start) | ||||
| @@ -554,17 +446,11 @@ def do_pull_minutes_active( | ||||
|     return len(rows) | ||||
|  | ||||
|  | ||||
| def count_message_by_user_query(realm: Realm | None) -> QueryFn: | ||||
| def count_message_by_user_query(realm: Optional[Realm]) -> QueryFn: | ||||
|     if realm is None: | ||||
|         realm_clause: Composable = SQL("") | ||||
|         realm_clause = SQL("") | ||||
|     else: | ||||
|         # We limit both userprofile and message so that we only see | ||||
|         # users from this realm, but also get the performance speedup | ||||
|         # of limiting messages by realm. | ||||
|         realm_clause = SQL( | ||||
|             "zerver_userprofile.realm_id = {} AND zerver_message.realm_id = {} AND" | ||||
|         ).format(Literal(realm.id), Literal(realm.id)) | ||||
|     # Uses index: zerver_message_realm_date_sent (or the only-date index) | ||||
|         realm_clause = SQL("zerver_userprofile.realm_id = {} AND").format(Literal(realm.id)) | ||||
|     return lambda kwargs: SQL( | ||||
|         """ | ||||
|     INSERT INTO analytics_usercount | ||||
| @@ -587,17 +473,11 @@ def count_message_by_user_query(realm: Realm | None) -> QueryFn: | ||||
|  | ||||
|  | ||||
| # Note: ignores the group_by / group_by_clause. | ||||
| def count_message_type_by_user_query(realm: Realm | None) -> QueryFn: | ||||
| def count_message_type_by_user_query(realm: Optional[Realm]) -> QueryFn: | ||||
|     if realm is None: | ||||
|         realm_clause: Composable = SQL("") | ||||
|         realm_clause = SQL("") | ||||
|     else: | ||||
|         # We limit both userprofile and message so that we only see | ||||
|         # users from this realm, but also get the performance speedup | ||||
|         # of limiting messages by realm. | ||||
|         realm_clause = SQL( | ||||
|             "zerver_userprofile.realm_id = {} AND zerver_message.realm_id = {} AND" | ||||
|         ).format(Literal(realm.id), Literal(realm.id)) | ||||
|     # Uses index: zerver_message_realm_date_sent (or the only-date index) | ||||
|         realm_clause = SQL("zerver_userprofile.realm_id = {} AND").format(Literal(realm.id)) | ||||
|     return lambda kwargs: SQL( | ||||
|         """ | ||||
|     INSERT INTO analytics_usercount | ||||
| @@ -642,14 +522,11 @@ def count_message_type_by_user_query(realm: Realm | None) -> QueryFn: | ||||
| # use this also subgroup on UserProfile.is_bot. If in the future there is a | ||||
| # stat that counts messages by stream and doesn't need the UserProfile | ||||
| # table, consider writing a new query for efficiency. | ||||
| def count_message_by_stream_query(realm: Realm | None) -> QueryFn: | ||||
| def count_message_by_stream_query(realm: Optional[Realm]) -> QueryFn: | ||||
|     if realm is None: | ||||
|         realm_clause: Composable = SQL("") | ||||
|         realm_clause = SQL("") | ||||
|     else: | ||||
|         realm_clause = SQL( | ||||
|             "zerver_stream.realm_id = {} AND zerver_message.realm_id = {} AND" | ||||
|         ).format(Literal(realm.id), Literal(realm.id)) | ||||
|     # Uses index: zerver_message_realm_date_sent (or the only-date index) | ||||
|         realm_clause = SQL("zerver_stream.realm_id = {} AND").format(Literal(realm.id)) | ||||
|     return lambda kwargs: SQL( | ||||
|         """ | ||||
|     INSERT INTO analytics_streamcount | ||||
| @@ -677,39 +554,67 @@ def count_message_by_stream_query(realm: Realm | None) -> QueryFn: | ||||
|     ).format(**kwargs, realm_clause=realm_clause) | ||||
|  | ||||
|  | ||||
| # Hardcodes the query needed for active_users_audit:is_bot:day. | ||||
| # Assumes that a user cannot have two RealmAuditLog entries with the | ||||
| # same event_time and event_type in [RealmAuditLog.USER_CREATED, | ||||
| # USER_DEACTIVATED, etc].  In particular, it's important to ensure | ||||
| # that migrations don't cause that to happen. | ||||
| def check_realmauditlog_by_user_query(realm: Realm | None) -> QueryFn: | ||||
| # Hardcodes the query needed by active_users:is_bot:day, since that is | ||||
| # currently the only stat that uses this. | ||||
| def count_user_by_realm_query(realm: Optional[Realm]) -> QueryFn: | ||||
|     if realm is None: | ||||
|         realm_clause: Composable = SQL("") | ||||
|         realm_clause = SQL("") | ||||
|     else: | ||||
|         realm_clause = SQL("realm_id = {} AND").format(Literal(realm.id)) | ||||
|         realm_clause = SQL("zerver_userprofile.realm_id = {} AND").format(Literal(realm.id)) | ||||
|     return lambda kwargs: SQL( | ||||
|         """ | ||||
|     INSERT INTO analytics_realmcount | ||||
|         (realm_id, value, property, subgroup, end_time) | ||||
|     SELECT | ||||
|         zerver_userprofile.realm_id, count(*), %(property)s, {subgroup}, %(time_end)s | ||||
|     FROM zerver_userprofile | ||||
|     JOIN ( | ||||
|             SELECT DISTINCT ON (modified_user_id) | ||||
|                     modified_user_id, event_type | ||||
|             FROM | ||||
|                     zerver_realmauditlog | ||||
|         zerver_realm.id, count(*), %(property)s, {subgroup}, %(time_end)s | ||||
|     FROM zerver_realm | ||||
|     JOIN zerver_userprofile | ||||
|     ON | ||||
|         zerver_realm.id = zerver_userprofile.realm_id | ||||
|     WHERE | ||||
|                     event_type IN ({user_created}, {user_activated}, {user_deactivated}, {user_reactivated}) AND | ||||
|         zerver_realm.date_created < %(time_end)s AND | ||||
|         zerver_userprofile.date_joined >= %(time_start)s AND | ||||
|         zerver_userprofile.date_joined < %(time_end)s AND | ||||
|         {realm_clause} | ||||
|         zerver_userprofile.is_active = TRUE | ||||
|     GROUP BY zerver_realm.id {group_by_clause} | ||||
| """ | ||||
|     ).format(**kwargs, realm_clause=realm_clause) | ||||
|  | ||||
|  | ||||
| # Currently hardcodes the query needed for active_users_audit:is_bot:day. | ||||
| # Assumes that a user cannot have two RealmAuditLog entries with the same event_time and | ||||
| # event_type in [RealmAuditLog.USER_CREATED, USER_DEACTIVATED, etc]. | ||||
| # In particular, it's important to ensure that migrations don't cause that to happen. | ||||
| def check_realmauditlog_by_user_query(realm: Optional[Realm]) -> QueryFn: | ||||
|     if realm is None: | ||||
|         realm_clause = SQL("") | ||||
|     else: | ||||
|         realm_clause = SQL("realm_id = {} AND").format(Literal(realm.id)) | ||||
|     return lambda kwargs: SQL( | ||||
|         """ | ||||
|     INSERT INTO analytics_usercount | ||||
|         (user_id, realm_id, value, property, subgroup, end_time) | ||||
|     SELECT | ||||
|         ral1.modified_user_id, ral1.realm_id, 1, %(property)s, {subgroup}, %(time_end)s | ||||
|     FROM zerver_realmauditlog ral1 | ||||
|     JOIN ( | ||||
|         SELECT modified_user_id, max(event_time) AS max_event_time | ||||
|         FROM zerver_realmauditlog | ||||
|         WHERE | ||||
|             event_type in ({user_created}, {user_activated}, {user_deactivated}, {user_reactivated}) AND | ||||
|             {realm_clause} | ||||
|             event_time < %(time_end)s | ||||
|             ORDER BY | ||||
|                     modified_user_id, | ||||
|                     event_time DESC | ||||
|     ) last_user_event ON last_user_event.modified_user_id = zerver_userprofile.id | ||||
|         GROUP BY modified_user_id | ||||
|     ) ral2 | ||||
|     ON | ||||
|         ral1.event_time = max_event_time AND | ||||
|         ral1.modified_user_id = ral2.modified_user_id | ||||
|     JOIN zerver_userprofile | ||||
|     ON | ||||
|         ral1.modified_user_id = zerver_userprofile.id | ||||
|     WHERE | ||||
|         last_user_event.event_type in ({user_created}, {user_activated}, {user_reactivated}) | ||||
|     GROUP BY zerver_userprofile.realm_id {group_by_clause} | ||||
|         ral1.event_type in ({user_created}, {user_activated}, {user_reactivated}) | ||||
|     """ | ||||
|     ).format( | ||||
|         **kwargs, | ||||
| @@ -721,9 +626,9 @@ def check_realmauditlog_by_user_query(realm: Realm | None) -> QueryFn: | ||||
|     ) | ||||
|  | ||||
|  | ||||
| def check_useractivityinterval_by_user_query(realm: Realm | None) -> QueryFn: | ||||
| def check_useractivityinterval_by_user_query(realm: Optional[Realm]) -> QueryFn: | ||||
|     if realm is None: | ||||
|         realm_clause: Composable = SQL("") | ||||
|         realm_clause = SQL("") | ||||
|     else: | ||||
|         realm_clause = SQL("zerver_userprofile.realm_id = {} AND").format(Literal(realm.id)) | ||||
|     return lambda kwargs: SQL( | ||||
| @@ -745,9 +650,9 @@ def check_useractivityinterval_by_user_query(realm: Realm | None) -> QueryFn: | ||||
|     ).format(**kwargs, realm_clause=realm_clause) | ||||
|  | ||||
|  | ||||
| def count_realm_active_humans_query(realm: Realm | None) -> QueryFn: | ||||
| def count_realm_active_humans_query(realm: Optional[Realm]) -> QueryFn: | ||||
|     if realm is None: | ||||
|         realm_clause: Composable = SQL("") | ||||
|         realm_clause = SQL("") | ||||
|     else: | ||||
|         realm_clause = SQL("realm_id = {} AND").format(Literal(realm.id)) | ||||
|     return lambda kwargs: SQL( | ||||
| @@ -755,45 +660,29 @@ def count_realm_active_humans_query(realm: Realm | None) -> QueryFn: | ||||
|     INSERT INTO analytics_realmcount | ||||
|         (realm_id, value, property, subgroup, end_time) | ||||
|     SELECT | ||||
|             active_usercount.realm_id, count(*), %(property)s, NULL, %(time_end)s | ||||
|         usercount1.realm_id, count(*), %(property)s, NULL, %(time_end)s | ||||
|     FROM ( | ||||
|             SELECT | ||||
|                     realm_id, | ||||
|                     user_id | ||||
|             FROM | ||||
|                     analytics_usercount | ||||
|         SELECT realm_id, user_id | ||||
|         FROM analytics_usercount | ||||
|         WHERE | ||||
|                     property = '15day_actives::day' | ||||
|             property = 'active_users_audit:is_bot:day' AND | ||||
|             subgroup = 'false' AND | ||||
|             {realm_clause} | ||||
|                     AND end_time = %(time_end)s | ||||
|     ) active_usercount | ||||
|     JOIN zerver_userprofile ON active_usercount.user_id = zerver_userprofile.id | ||||
|             end_time = %(time_end)s | ||||
|     ) usercount1 | ||||
|     JOIN ( | ||||
|             SELECT DISTINCT ON (modified_user_id) | ||||
|                     modified_user_id, event_type | ||||
|             FROM | ||||
|                     zerver_realmauditlog | ||||
|         SELECT realm_id, user_id | ||||
|         FROM analytics_usercount | ||||
|         WHERE | ||||
|                     event_type IN ({user_created}, {user_activated}, {user_deactivated}, {user_reactivated}) | ||||
|                     AND event_time < %(time_end)s | ||||
|             ORDER BY | ||||
|                     modified_user_id, | ||||
|                     event_time DESC | ||||
|     ) last_user_event ON last_user_event.modified_user_id = active_usercount.user_id | ||||
|     WHERE | ||||
|             NOT zerver_userprofile.is_bot | ||||
|             AND event_type IN ({user_created}, {user_activated}, {user_reactivated}) | ||||
|     GROUP BY | ||||
|             active_usercount.realm_id | ||||
|             property = '15day_actives::day' AND | ||||
|             {realm_clause} | ||||
|             end_time = %(time_end)s | ||||
|     ) usercount2 | ||||
|     ON | ||||
|         usercount1.user_id = usercount2.user_id | ||||
|     GROUP BY usercount1.realm_id | ||||
| """ | ||||
|     ).format( | ||||
|         **kwargs, | ||||
|         user_created=Literal(RealmAuditLog.USER_CREATED), | ||||
|         user_activated=Literal(RealmAuditLog.USER_ACTIVATED), | ||||
|         user_deactivated=Literal(RealmAuditLog.USER_DEACTIVATED), | ||||
|         user_reactivated=Literal(RealmAuditLog.USER_REACTIVATED), | ||||
|         realm_clause=realm_clause, | ||||
|     ) | ||||
|     ).format(**kwargs, realm_clause=realm_clause) | ||||
|  | ||||
|  | ||||
| # Currently unused and untested | ||||
| @@ -816,7 +705,7 @@ count_stream_by_realm_query = lambda kwargs: SQL( | ||||
| ).format(**kwargs) | ||||
|  | ||||
|  | ||||
| def get_count_stats(realm: Realm | None = None) -> dict[str, CountStat]: | ||||
| def get_count_stats(realm: Optional[Realm] = None) -> Dict[str, CountStat]: | ||||
|     ## CountStat declarations ## | ||||
|  | ||||
|     count_stats_ = [ | ||||
| @@ -849,19 +738,39 @@ def get_count_stats(realm: Realm | None = None) -> dict[str, CountStat]: | ||||
|             ), | ||||
|             CountStat.DAY, | ||||
|         ), | ||||
|         # Counts the number of active users in the UserProfile.is_active sense. | ||||
|         # Number of users stats | ||||
|         # Stats that count the number of active users in the UserProfile.is_active sense. | ||||
|         # 'active_users_audit:is_bot:day' is the canonical record of which users were | ||||
|         # active on which days (in the UserProfile.is_active sense). | ||||
|         # Important that this stay a daily stat, so that 'realm_active_humans::day' works as expected. | ||||
|         CountStat( | ||||
|             "active_users_audit:is_bot:day", | ||||
|             sql_data_collector( | ||||
|                 RealmCount, check_realmauditlog_by_user_query(realm), (UserProfile, "is_bot") | ||||
|                 UserCount, check_realmauditlog_by_user_query(realm), (UserProfile, "is_bot") | ||||
|             ), | ||||
|             CountStat.DAY, | ||||
|         ), | ||||
|         # Important note: LoggingCountStat objects aren't passed the | ||||
|         # Realm argument, because by nature they have a logging | ||||
|         # structure, not a pull-from-database structure, so there's no | ||||
|         # way to compute them for a single realm after the fact (the | ||||
|         # use case for passing a Realm argument). | ||||
|         # Sanity check on 'active_users_audit:is_bot:day', and a archetype for future LoggingCountStats. | ||||
|         # In RealmCount, 'active_users_audit:is_bot:day' should be the partial | ||||
|         # sum sequence of 'active_users_log:is_bot:day', for any realm that | ||||
|         # started after the latter stat was introduced. | ||||
|         LoggingCountStat("active_users_log:is_bot:day", RealmCount, CountStat.DAY), | ||||
|         # Another sanity check on 'active_users_audit:is_bot:day'. Is only an | ||||
|         # approximation, e.g. if a user is deactivated between the end of the | ||||
|         # day and when this stat is run, they won't be counted. However, is the | ||||
|         # simplest of the three to inspect by hand. | ||||
|         CountStat( | ||||
|             "upload_quota_used_bytes::day", | ||||
|             sql_data_collector(RealmCount, count_upload_space_used_by_realm_query(realm), None), | ||||
|             "active_users:is_bot:day", | ||||
|             sql_data_collector( | ||||
|                 RealmCount, count_user_by_realm_query(realm), (UserProfile, "is_bot") | ||||
|             ), | ||||
|             CountStat.DAY, | ||||
|             interval=TIMEDELTA_MAX, | ||||
|         ), | ||||
|         # Messages read stats.  messages_read::hour is the total | ||||
|         # number of messages read, whereas | ||||
| @@ -895,16 +804,8 @@ def get_count_stats(realm: Realm | None = None) -> dict[str, CountStat]: | ||||
|         CountStat( | ||||
|             "minutes_active::day", DataCollector(UserCount, do_pull_minutes_active), CountStat.DAY | ||||
|         ), | ||||
|         # Tracks the number of push notifications requested by the server. | ||||
|         # Included in LOGGING_COUNT_STAT_PROPERTIES_NOT_SENT_TO_BOUNCER. | ||||
|         LoggingCountStat( | ||||
|             "mobile_pushes_sent::day", | ||||
|             RealmCount, | ||||
|             CountStat.DAY, | ||||
|         ), | ||||
|         # Rate limiting stats | ||||
|         # Used to limit the number of invitation emails sent by a realm. | ||||
|         # Included in LOGGING_COUNT_STAT_PROPERTIES_NOT_SENT_TO_BOUNCER. | ||||
|         # Used to limit the number of invitation emails sent by a realm | ||||
|         LoggingCountStat("invites_sent::day", RealmCount, CountStat.DAY), | ||||
|         # Dependent stats | ||||
|         # Must come after their dependencies. | ||||
| @@ -913,83 +814,12 @@ def get_count_stats(realm: Realm | None = None) -> dict[str, CountStat]: | ||||
|             "realm_active_humans::day", | ||||
|             sql_data_collector(RealmCount, count_realm_active_humans_query(realm), None), | ||||
|             CountStat.DAY, | ||||
|             dependencies=["15day_actives::day"], | ||||
|             dependencies=["active_users_audit:is_bot:day", "15day_actives::day"], | ||||
|         ), | ||||
|     ] | ||||
|  | ||||
|     if settings.ZILENCER_ENABLED: | ||||
|         # See also the remote_installation versions of these in REMOTE_INSTALLATION_COUNT_STATS. | ||||
|         count_stats_.append( | ||||
|             LoggingCountStat( | ||||
|                 "mobile_pushes_received::day", | ||||
|                 RemoteRealmCount, | ||||
|                 CountStat.DAY, | ||||
|             ) | ||||
|         ) | ||||
|         count_stats_.append( | ||||
|             LoggingCountStat( | ||||
|                 "mobile_pushes_forwarded::day", | ||||
|                 RemoteRealmCount, | ||||
|                 CountStat.DAY, | ||||
|             ) | ||||
|         ) | ||||
|  | ||||
|     return OrderedDict((stat.property, stat) for stat in count_stats_) | ||||
|  | ||||
|  | ||||
| # These properties are tracked by the bouncer itself and therefore syncing them | ||||
| # from a remote server should not be allowed - or the server would be able to interfere | ||||
| # with our data. | ||||
| BOUNCER_ONLY_REMOTE_COUNT_STAT_PROPERTIES = [ | ||||
|     "mobile_pushes_received::day", | ||||
|     "mobile_pushes_forwarded::day", | ||||
| ] | ||||
|  | ||||
| # LoggingCountStats with a daily duration and that are directly stored on | ||||
| # the RealmCount table (instead of via aggregation in process_count_stat), | ||||
| # can be in a state, after the hourly cron job to update analytics counts, | ||||
| # where the logged value will be live-updated later (as the end time for | ||||
| # the stat is still in the future). As these logging counts are designed | ||||
| # to be used on the self-hosted installation for either debugging or rate | ||||
| # limiting, sending these incomplete counts to the bouncer has low value. | ||||
| LOGGING_COUNT_STAT_PROPERTIES_NOT_SENT_TO_BOUNCER = { | ||||
|     "invites_sent::day", | ||||
|     "mobile_pushes_sent::day", | ||||
|     "active_users_log:is_bot:day", | ||||
|     "active_users:is_bot:day", | ||||
| } | ||||
|  | ||||
| # To avoid refactoring for now COUNT_STATS can be used as before | ||||
| COUNT_STATS = get_count_stats() | ||||
|  | ||||
| REMOTE_INSTALLATION_COUNT_STATS = OrderedDict() | ||||
|  | ||||
| if settings.ZILENCER_ENABLED: | ||||
|     # REMOTE_INSTALLATION_COUNT_STATS contains duplicates of the | ||||
|     # RemoteRealmCount stats declared above; it is necessary because | ||||
|     # pre-8.0 servers do not send the fields required to identify a | ||||
|     # RemoteRealm. | ||||
|  | ||||
|     # Tracks the number of push notifications requested to be sent | ||||
|     # by a remote server. | ||||
|     REMOTE_INSTALLATION_COUNT_STATS["mobile_pushes_received::day"] = LoggingCountStat( | ||||
|         "mobile_pushes_received::day", | ||||
|         RemoteInstallationCount, | ||||
|         CountStat.DAY, | ||||
|     ) | ||||
|     # Tracks the number of push notifications successfully sent to | ||||
|     # mobile devices, as requested by the remote server. Therefore | ||||
|     # this should be less than or equal to mobile_pushes_received - | ||||
|     # with potential tiny offsets resulting from a request being | ||||
|     # *received* by the bouncer right before midnight, but *sent* to | ||||
|     # the mobile device right after midnight. This would cause the | ||||
|     # increments to happen to CountStat records for different days. | ||||
|     REMOTE_INSTALLATION_COUNT_STATS["mobile_pushes_forwarded::day"] = LoggingCountStat( | ||||
|         "mobile_pushes_forwarded::day", | ||||
|         RemoteInstallationCount, | ||||
|         CountStat.DAY, | ||||
|     ) | ||||
|  | ||||
| ALL_COUNT_STATS = OrderedDict( | ||||
|     list(COUNT_STATS.items()) + list(REMOTE_INSTALLATION_COUNT_STATS.items()) | ||||
| ) | ||||
|   | ||||
| @@ -1,5 +1,6 @@ | ||||
| from math import sqrt | ||||
| from random import Random | ||||
| from random import gauss, random, seed | ||||
| from typing import List | ||||
|  | ||||
| from analytics.lib.counts import CountStat | ||||
|  | ||||
| @@ -15,7 +16,7 @@ def generate_time_series_data( | ||||
|     frequency: str = CountStat.DAY, | ||||
|     partial_sum: bool = False, | ||||
|     random_seed: int = 26, | ||||
| ) -> list[int]: | ||||
| ) -> List[int]: | ||||
|     """ | ||||
|     Generate semi-realistic looking time series data for testing analytics graphs. | ||||
|  | ||||
| @@ -35,8 +36,6 @@ def generate_time_series_data( | ||||
|     partial_sum -- If True, return partial sum of the series. | ||||
|     random_seed -- Seed for random number generator. | ||||
|     """ | ||||
|     rng = Random(random_seed) | ||||
|  | ||||
|     if frequency == CountStat.HOUR: | ||||
|         length = days * 24 | ||||
|         seasonality = [non_business_hours_base] * 24 * 7 | ||||
| @@ -45,13 +44,13 @@ def generate_time_series_data( | ||||
|                 seasonality[24 * day + hour] = business_hours_base | ||||
|         holidays = [] | ||||
|         for i in range(days): | ||||
|             holidays.extend([rng.random() < holiday_rate] * 24) | ||||
|             holidays.extend([random() < holiday_rate] * 24) | ||||
|     elif frequency == CountStat.DAY: | ||||
|         length = days | ||||
|         seasonality = [8 * business_hours_base + 16 * non_business_hours_base] * 5 + [ | ||||
|             24 * non_business_hours_base | ||||
|         ] * 2 | ||||
|         holidays = [rng.random() < holiday_rate for i in range(days)] | ||||
|         holidays = [random() < holiday_rate for i in range(days)] | ||||
|     else: | ||||
|         raise AssertionError(f"Unknown frequency: {frequency}") | ||||
|     if length < 2: | ||||
| @@ -59,17 +58,20 @@ def generate_time_series_data( | ||||
|             f"Must be generating at least 2 data points. Currently generating {length}" | ||||
|         ) | ||||
|     growth_base = growth ** (1.0 / (length - 1)) | ||||
|     values_no_noise = [seasonality[i % len(seasonality)] * (growth_base**i) for i in range(length)] | ||||
|     values_no_noise = [ | ||||
|         seasonality[i % len(seasonality)] * (growth_base ** i) for i in range(length) | ||||
|     ] | ||||
|  | ||||
|     noise_scalars = [rng.gauss(0, 1)] | ||||
|     seed(random_seed) | ||||
|     noise_scalars = [gauss(0, 1)] | ||||
|     for i in range(1, length): | ||||
|         noise_scalars.append( | ||||
|             noise_scalars[-1] * autocorrelation + rng.gauss(0, 1) * (1 - autocorrelation) | ||||
|             noise_scalars[-1] * autocorrelation + gauss(0, 1) * (1 - autocorrelation) | ||||
|         ) | ||||
|  | ||||
|     values = [ | ||||
|         0 if holiday else int(v + sqrt(v) * noise_scalar * spikiness) | ||||
|         for v, noise_scalar, holiday in zip(values_no_noise, noise_scalars, holidays, strict=False) | ||||
|         for v, noise_scalar, holiday in zip(values_no_noise, noise_scalars, holidays) | ||||
|     ] | ||||
|     if partial_sum: | ||||
|         for i in range(1, length): | ||||
|   | ||||
| @@ -1,4 +1,5 @@ | ||||
| from datetime import datetime, timedelta | ||||
| from typing import List, Optional | ||||
|  | ||||
| from analytics.lib.counts import CountStat | ||||
| from zerver.lib.timestamp import floor_to_day, floor_to_hour, verify_UTC | ||||
| @@ -9,8 +10,8 @@ from zerver.lib.timestamp import floor_to_day, floor_to_hour, verify_UTC | ||||
| # So informally, time_range(Sep 20, Sep 22, day, None) returns [Sep 20, Sep 21, Sep 22], | ||||
| # and time_range(Sep 20, Sep 22, day, 5) returns [Sep 18, Sep 19, Sep 20, Sep 21, Sep 22] | ||||
| def time_range( | ||||
|     start: datetime, end: datetime, frequency: str, min_length: int | None | ||||
| ) -> list[datetime]: | ||||
|     start: datetime, end: datetime, frequency: str, min_length: Optional[int] | ||||
| ) -> List[datetime]: | ||||
|     verify_UTC(start) | ||||
|     verify_UTC(end) | ||||
|     if frequency == CountStat.HOUR: | ||||
| @@ -29,5 +30,4 @@ def time_range( | ||||
|     while current >= start: | ||||
|         times.append(current) | ||||
|         current -= step | ||||
|     times.reverse() | ||||
|     return times | ||||
|     return list(reversed(times)) | ||||
|   | ||||
| @@ -1,15 +1,14 @@ | ||||
| from dataclasses import dataclass | ||||
| import os | ||||
| import time | ||||
| from datetime import timedelta | ||||
| from typing import Any, Literal | ||||
| from typing import Any, Dict | ||||
|  | ||||
| from django.core.management.base import BaseCommand | ||||
| from django.utils.timezone import now as timezone_now | ||||
| from typing_extensions import override | ||||
|  | ||||
| from analytics.lib.counts import ALL_COUNT_STATS, CountStat | ||||
| from analytics.lib.counts import COUNT_STATS, CountStat | ||||
| from analytics.models import installation_epoch | ||||
| from scripts.lib.zulip_tools import atomic_nagios_write | ||||
| from zerver.lib.management import ZulipBaseCommand | ||||
| from zerver.lib.timestamp import TimeZoneNotUTCError, floor_to_day, floor_to_hour, verify_UTC | ||||
| from zerver.lib.timestamp import TimezoneNotUTCException, floor_to_day, floor_to_hour, verify_UTC | ||||
| from zerver.models import Realm | ||||
|  | ||||
| states = { | ||||
| @@ -20,38 +19,37 @@ states = { | ||||
| } | ||||
|  | ||||
|  | ||||
| @dataclass | ||||
| class NagiosResult: | ||||
|     status: Literal["ok", "warning", "critical", "unknown"] | ||||
|     message: str | ||||
|  | ||||
|  | ||||
| class Command(ZulipBaseCommand): | ||||
| class Command(BaseCommand): | ||||
|     help = """Checks FillState table. | ||||
|  | ||||
|     Run as a cron job that runs every hour.""" | ||||
|  | ||||
|     @override | ||||
|     def handle(self, *args: Any, **options: Any) -> None: | ||||
|         fill_state = self.get_fill_state() | ||||
|         atomic_nagios_write("check-analytics-state", fill_state.status, fill_state.message) | ||||
|         status = fill_state["status"] | ||||
|         message = fill_state["message"] | ||||
|  | ||||
|     def get_fill_state(self) -> NagiosResult: | ||||
|         state_file_path = "/var/lib/nagios_state/check-analytics-state" | ||||
|         state_file_tmp = state_file_path + "-tmp" | ||||
|  | ||||
|         with open(state_file_tmp, "w") as f: | ||||
|             f.write(f"{int(time.time())}|{status}|{states[status]}|{message}\n") | ||||
|         os.rename(state_file_tmp, state_file_path) | ||||
|  | ||||
|     def get_fill_state(self) -> Dict[str, Any]: | ||||
|         if not Realm.objects.exists(): | ||||
|             return NagiosResult(status="ok", message="No realms exist, so not checking FillState.") | ||||
|             return {"status": 0, "message": "No realms exist, so not checking FillState."} | ||||
|  | ||||
|         warning_unfilled_properties = [] | ||||
|         critical_unfilled_properties = [] | ||||
|         for property, stat in ALL_COUNT_STATS.items(): | ||||
|         for property, stat in COUNT_STATS.items(): | ||||
|             last_fill = stat.last_successful_fill() | ||||
|             if last_fill is None: | ||||
|                 last_fill = installation_epoch() | ||||
|             try: | ||||
|                 verify_UTC(last_fill) | ||||
|             except TimeZoneNotUTCError: | ||||
|                 return NagiosResult( | ||||
|                     status="critical", message=f"FillState not in UTC for {property}" | ||||
|                 ) | ||||
|             except TimezoneNotUTCException: | ||||
|                 return {"status": 2, "message": f"FillState not in UTC for {property}"} | ||||
|  | ||||
|             if stat.frequency == CountStat.DAY: | ||||
|                 floor_function = floor_to_day | ||||
| @@ -63,10 +61,10 @@ class Command(ZulipBaseCommand): | ||||
|                 critical_threshold = timedelta(minutes=150) | ||||
|  | ||||
|             if floor_function(last_fill) != last_fill: | ||||
|                 return NagiosResult( | ||||
|                     status="critical", | ||||
|                     message=f"FillState not on {stat.frequency} boundary for {property}", | ||||
|                 ) | ||||
|                 return { | ||||
|                     "status": 2, | ||||
|                     "message": f"FillState not on {stat.frequency} boundary for {property}", | ||||
|                 } | ||||
|  | ||||
|             time_to_last_fill = timezone_now() - last_fill | ||||
|             if time_to_last_fill > critical_threshold: | ||||
| @@ -75,18 +73,18 @@ class Command(ZulipBaseCommand): | ||||
|                 warning_unfilled_properties.append(property) | ||||
|  | ||||
|         if len(critical_unfilled_properties) == 0 and len(warning_unfilled_properties) == 0: | ||||
|             return NagiosResult(status="ok", message="FillState looks fine.") | ||||
|             return {"status": 0, "message": "FillState looks fine."} | ||||
|         if len(critical_unfilled_properties) == 0: | ||||
|             return NagiosResult( | ||||
|                 status="warning", | ||||
|                 message="Missed filling {} once.".format( | ||||
|             return { | ||||
|                 "status": 1, | ||||
|                 "message": "Missed filling {} once.".format( | ||||
|                     ", ".join(warning_unfilled_properties), | ||||
|                 ), | ||||
|             ) | ||||
|         return NagiosResult( | ||||
|             status="critical", | ||||
|             message="Missed filling {} once. Missed filling {} at least twice.".format( | ||||
|             } | ||||
|         return { | ||||
|             "status": 2, | ||||
|             "message": "Missed filling {} once. Missed filling {} at least twice.".format( | ||||
|                 ", ".join(warning_unfilled_properties), | ||||
|                 ", ".join(critical_unfilled_properties), | ||||
|             ), | ||||
|         ) | ||||
|         } | ||||
|   | ||||
| @@ -1,21 +1,17 @@ | ||||
| from argparse import ArgumentParser | ||||
| from typing import Any | ||||
|  | ||||
| from django.core.management.base import CommandError | ||||
| from typing_extensions import override | ||||
| from django.core.management.base import BaseCommand, CommandError | ||||
|  | ||||
| from analytics.lib.counts import do_drop_all_analytics_tables | ||||
| from zerver.lib.management import ZulipBaseCommand | ||||
|  | ||||
|  | ||||
| class Command(ZulipBaseCommand): | ||||
| class Command(BaseCommand): | ||||
|     help = """Clear analytics tables.""" | ||||
|  | ||||
|     @override | ||||
|     def add_arguments(self, parser: ArgumentParser) -> None: | ||||
|         parser.add_argument("--force", action="store_true", help="Clear analytics tables.") | ||||
|  | ||||
|     @override | ||||
|     def handle(self, *args: Any, **options: Any) -> None: | ||||
|         if options["force"]: | ||||
|             do_drop_all_analytics_tables() | ||||
|   | ||||
| @@ -1,25 +1,21 @@ | ||||
| from argparse import ArgumentParser | ||||
| from typing import Any | ||||
|  | ||||
| from django.core.management.base import CommandError | ||||
| from typing_extensions import override | ||||
| from django.core.management.base import BaseCommand, CommandError | ||||
|  | ||||
| from analytics.lib.counts import ALL_COUNT_STATS, do_drop_single_stat | ||||
| from zerver.lib.management import ZulipBaseCommand | ||||
| from analytics.lib.counts import COUNT_STATS, do_drop_single_stat | ||||
|  | ||||
|  | ||||
| class Command(ZulipBaseCommand): | ||||
| class Command(BaseCommand): | ||||
|     help = """Clear analytics tables.""" | ||||
|  | ||||
|     @override | ||||
|     def add_arguments(self, parser: ArgumentParser) -> None: | ||||
|         parser.add_argument("--force", action="store_true", help="Actually do it.") | ||||
|         parser.add_argument("--property", help="The property of the stat to be cleared.") | ||||
|  | ||||
|     @override | ||||
|     def handle(self, *args: Any, **options: Any) -> None: | ||||
|         property = options["property"] | ||||
|         if property not in ALL_COUNT_STATS: | ||||
|         if property not in COUNT_STATS: | ||||
|             raise CommandError(f"Invalid property: {property}") | ||||
|         if not options["force"]: | ||||
|             raise CommandError("No action taken. Use --force.") | ||||
|   | ||||
| @@ -1,10 +1,9 @@ | ||||
| from collections.abc import Mapping | ||||
| from datetime import timedelta | ||||
| from typing import Any, TypeAlias | ||||
| from typing import Any, Dict, List, Mapping, Optional, Type | ||||
| from unittest import mock | ||||
|  | ||||
| from django.core.files.uploadedfile import UploadedFile | ||||
| from django.core.management.base import BaseCommand | ||||
| from django.utils.timezone import now as timezone_now | ||||
| from typing_extensions import override | ||||
|  | ||||
| from analytics.lib.counts import COUNT_STATS, CountStat, do_drop_all_analytics_tables | ||||
| from analytics.lib.fixtures import generate_time_series_data | ||||
| @@ -17,28 +16,13 @@ from analytics.models import ( | ||||
|     StreamCount, | ||||
|     UserCount, | ||||
| ) | ||||
| from zerver.actions.create_realm import do_create_realm | ||||
| from zerver.actions.users import do_change_user_role | ||||
| from zerver.lib.actions import STREAM_ASSIGNMENT_COLORS, do_change_user_role, do_create_realm | ||||
| from zerver.lib.create_user import create_user | ||||
| from zerver.lib.management import ZulipBaseCommand | ||||
| from zerver.lib.storage import static_path | ||||
| from zerver.lib.stream_color import STREAM_ASSIGNMENT_COLORS | ||||
| from zerver.lib.timestamp import floor_to_day | ||||
| from zerver.lib.upload import upload_message_attachment_from_request | ||||
| from zerver.models import ( | ||||
|     Client, | ||||
|     NamedUserGroup, | ||||
|     Realm, | ||||
|     RealmAuditLog, | ||||
|     Recipient, | ||||
|     Stream, | ||||
|     Subscription, | ||||
|     UserProfile, | ||||
| ) | ||||
| from zerver.models.groups import SystemGroups | ||||
| from zerver.models import Client, Realm, Recipient, Stream, Subscription, UserProfile | ||||
|  | ||||
|  | ||||
| class Command(ZulipBaseCommand): | ||||
| class Command(BaseCommand): | ||||
|     help = """Populates analytics tables with randomly generated data.""" | ||||
|  | ||||
|     DAYS_OF_DATA = 100 | ||||
| @@ -54,7 +38,7 @@ class Command(ZulipBaseCommand): | ||||
|         spikiness: float, | ||||
|         holiday_rate: float = 0, | ||||
|         partial_sum: bool = False, | ||||
|     ) -> list[int]: | ||||
|     ) -> List[int]: | ||||
|         self.random_seed += 1 | ||||
|         return generate_time_series_data( | ||||
|             days=self.DAYS_OF_DATA, | ||||
| @@ -69,7 +53,6 @@ class Command(ZulipBaseCommand): | ||||
|             random_seed=self.random_seed, | ||||
|         ) | ||||
|  | ||||
|     @override | ||||
|     def handle(self, *args: Any, **options: Any) -> None: | ||||
|         # TODO: This should arguably only delete the objects | ||||
|         # associated with the "analytics" realm. | ||||
| @@ -94,72 +77,40 @@ class Command(ZulipBaseCommand): | ||||
|             string_id="analytics", name="Analytics", date_created=installation_time | ||||
|         ) | ||||
|  | ||||
|         with mock.patch("zerver.lib.create_user.timezone_now", return_value=installation_time): | ||||
|             shylock = create_user( | ||||
|                 "shylock@analytics.ds", | ||||
|                 "Shylock", | ||||
|                 realm, | ||||
|                 full_name="Shylock", | ||||
|                 role=UserProfile.ROLE_REALM_OWNER, | ||||
|             force_date_joined=installation_time, | ||||
|             ) | ||||
|         do_change_user_role(shylock, UserProfile.ROLE_REALM_OWNER, acting_user=None) | ||||
|  | ||||
|         # Create guest user for set_guest_users_statistic. | ||||
|         create_user( | ||||
|             "bassanio@analytics.ds", | ||||
|             "Bassanio", | ||||
|             realm, | ||||
|             full_name="Bassanio", | ||||
|             role=UserProfile.ROLE_GUEST, | ||||
|             force_date_joined=installation_time, | ||||
|         ) | ||||
|  | ||||
|         administrators_user_group = NamedUserGroup.objects.get( | ||||
|             name=SystemGroups.ADMINISTRATORS, realm=realm, is_system_group=True | ||||
|         ) | ||||
|         stream = Stream.objects.create( | ||||
|             name="all", | ||||
|             realm=realm, | ||||
|             date_created=installation_time, | ||||
|             can_remove_subscribers_group=administrators_user_group, | ||||
|         ) | ||||
|         stream = Stream.objects.create(name="all", realm=realm, date_created=installation_time) | ||||
|         recipient = Recipient.objects.create(type_id=stream.id, type=Recipient.STREAM) | ||||
|         stream.recipient = recipient | ||||
|         stream.save(update_fields=["recipient"]) | ||||
|  | ||||
|         # Subscribe shylock to the stream to avoid invariant failures. | ||||
|         Subscription.objects.create( | ||||
|         # TODO: This should use subscribe_users_to_streams from populate_db. | ||||
|         subs = [ | ||||
|             Subscription( | ||||
|                 recipient=recipient, | ||||
|                 user_profile=shylock, | ||||
|                 is_user_active=shylock.is_active, | ||||
|                 color=STREAM_ASSIGNMENT_COLORS[0], | ||||
|         ) | ||||
|         RealmAuditLog.objects.create( | ||||
|             realm=realm, | ||||
|             modified_user=shylock, | ||||
|             modified_stream=stream, | ||||
|             event_last_message_id=0, | ||||
|             event_type=RealmAuditLog.SUBSCRIPTION_CREATED, | ||||
|             event_time=installation_time, | ||||
|         ) | ||||
|  | ||||
|         # Create an attachment in the database for set_storage_space_used_statistic. | ||||
|         IMAGE_FILE_PATH = static_path("images/test-images/checkbox.png") | ||||
|         with open(IMAGE_FILE_PATH, "rb") as fp: | ||||
|             upload_message_attachment_from_request(UploadedFile(fp), shylock) | ||||
|  | ||||
|         FixtureData: TypeAlias = Mapping[str | int | None, list[int]] | ||||
|             ), | ||||
|         ] | ||||
|         Subscription.objects.bulk_create(subs) | ||||
|  | ||||
|         def insert_fixture_data( | ||||
|             stat: CountStat, | ||||
|             fixture_data: FixtureData, | ||||
|             table: type[BaseCount], | ||||
|             stat: CountStat, fixture_data: Mapping[Optional[str], List[int]], table: Type[BaseCount] | ||||
|         ) -> None: | ||||
|             end_times = time_range( | ||||
|                 last_end_time, last_end_time, stat.frequency, len(next(iter(fixture_data.values()))) | ||||
|                 last_end_time, last_end_time, stat.frequency, len(list(fixture_data.values())[0]) | ||||
|             ) | ||||
|             if table == InstallationCount: | ||||
|                 id_args: dict[str, Any] = {} | ||||
|                 id_args: Dict[str, Any] = {} | ||||
|             if table == RealmCount: | ||||
|                 id_args = {"realm": realm} | ||||
|             if table == UserCount: | ||||
| @@ -168,7 +119,7 @@ class Command(ZulipBaseCommand): | ||||
|                 id_args = {"stream": stream, "realm": realm} | ||||
|  | ||||
|             for subgroup, values in fixture_data.items(): | ||||
|                 table._default_manager.bulk_create( | ||||
|                 table.objects.bulk_create( | ||||
|                     table( | ||||
|                         property=stat.property, | ||||
|                         subgroup=subgroup, | ||||
| @@ -176,16 +127,16 @@ class Command(ZulipBaseCommand): | ||||
|                         value=value, | ||||
|                         **id_args, | ||||
|                     ) | ||||
|                     for end_time, value in zip(end_times, values, strict=False) | ||||
|                     for end_time, value in zip(end_times, values) | ||||
|                     if value != 0 | ||||
|                 ) | ||||
|  | ||||
|         stat = COUNT_STATS["1day_actives::day"] | ||||
|         realm_data: FixtureData = { | ||||
|         realm_data: Mapping[Optional[str], List[int]] = { | ||||
|             None: self.generate_fixture_data(stat, 0.08, 0.02, 3, 0.3, 6, partial_sum=True), | ||||
|         } | ||||
|         insert_fixture_data(stat, realm_data, RealmCount) | ||||
|         installation_data: FixtureData = { | ||||
|         installation_data: Mapping[Optional[str], List[int]] = { | ||||
|             None: self.generate_fixture_data(stat, 0.8, 0.2, 4, 0.3, 6, partial_sum=True), | ||||
|         } | ||||
|         insert_fixture_data(stat, installation_data, InstallationCount) | ||||
| @@ -235,7 +186,7 @@ class Command(ZulipBaseCommand): | ||||
|         ) | ||||
|  | ||||
|         stat = COUNT_STATS["messages_sent:is_bot:hour"] | ||||
|         user_data: FixtureData = { | ||||
|         user_data: Mapping[Optional[str], List[int]] = { | ||||
|             "false": self.generate_fixture_data(stat, 2, 1, 1.5, 0.6, 8, holiday_rate=0.1), | ||||
|         } | ||||
|         insert_fixture_data(stat, user_data, UserCount) | ||||
| @@ -283,7 +234,6 @@ class Command(ZulipBaseCommand): | ||||
|         android, created = Client.objects.get_or_create(name="ZulipAndroid") | ||||
|         iOS, created = Client.objects.get_or_create(name="ZulipiOS") | ||||
|         react_native, created = Client.objects.get_or_create(name="ZulipMobile") | ||||
|         flutter, created = Client.objects.get_or_create(name="ZulipFlutter") | ||||
|         API, created = Client.objects.get_or_create(name="API: Python") | ||||
|         zephyr_mirror, created = Client.objects.get_or_create(name="zephyr_mirror") | ||||
|         unused, created = Client.objects.get_or_create(name="unused") | ||||
| @@ -301,7 +251,6 @@ class Command(ZulipBaseCommand): | ||||
|             android.id: self.generate_fixture_data(stat, 5, 5, 2, 0.6, 3), | ||||
|             iOS.id: self.generate_fixture_data(stat, 5, 5, 2, 0.6, 3), | ||||
|             react_native.id: self.generate_fixture_data(stat, 5, 5, 10, 0.6, 3), | ||||
|             flutter.id: self.generate_fixture_data(stat, 5, 5, 10, 0.6, 3), | ||||
|             API.id: self.generate_fixture_data(stat, 5, 5, 5, 0.6, 3), | ||||
|             zephyr_mirror.id: self.generate_fixture_data(stat, 1, 1, 3, 0.6, 3), | ||||
|             unused.id: self.generate_fixture_data(stat, 0, 0, 0, 0, 0), | ||||
| @@ -313,7 +262,6 @@ class Command(ZulipBaseCommand): | ||||
|             old_desktop.id: self.generate_fixture_data(stat, 50, 30, 8, 0.6, 3), | ||||
|             android.id: self.generate_fixture_data(stat, 50, 50, 2, 0.6, 3), | ||||
|             iOS.id: self.generate_fixture_data(stat, 50, 50, 2, 0.6, 3), | ||||
|             flutter.id: self.generate_fixture_data(stat, 5, 5, 10, 0.6, 3), | ||||
|             react_native.id: self.generate_fixture_data(stat, 5, 5, 10, 0.6, 3), | ||||
|             API.id: self.generate_fixture_data(stat, 50, 50, 5, 0.6, 3), | ||||
|             zephyr_mirror.id: self.generate_fixture_data(stat, 10, 10, 3, 0.6, 3), | ||||
| @@ -331,7 +279,7 @@ class Command(ZulipBaseCommand): | ||||
|             "true": self.generate_fixture_data(stat, 20, 2, 3, 0.2, 3), | ||||
|         } | ||||
|         insert_fixture_data(stat, realm_data, RealmCount) | ||||
|         stream_data: Mapping[int | str | None, list[int]] = { | ||||
|         stream_data: Mapping[Optional[str], List[int]] = { | ||||
|             "false": self.generate_fixture_data(stat, 10, 7, 5, 0.6, 4), | ||||
|             "true": self.generate_fixture_data(stat, 5, 3, 2, 0.4, 2), | ||||
|         } | ||||
|   | ||||
							
								
								
									
										61
									
								
								analytics/management/commands/stream_stats.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										61
									
								
								analytics/management/commands/stream_stats.py
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,61 @@ | ||||
| from argparse import ArgumentParser | ||||
| from typing import Any | ||||
|  | ||||
| from django.core.management.base import BaseCommand, CommandError | ||||
| from django.db.models import Q | ||||
|  | ||||
| from zerver.models import Message, Realm, Recipient, Stream, Subscription, get_realm | ||||
|  | ||||
|  | ||||
| class Command(BaseCommand): | ||||
|     help = "Generate statistics on the streams for a realm." | ||||
|  | ||||
|     def add_arguments(self, parser: ArgumentParser) -> None: | ||||
|         parser.add_argument( | ||||
|             "realms", metavar="<realm>", nargs="*", help="realm to generate statistics for" | ||||
|         ) | ||||
|  | ||||
|     def handle(self, *args: Any, **options: str) -> None: | ||||
|         if options["realms"]: | ||||
|             try: | ||||
|                 realms = [get_realm(string_id) for string_id in options["realms"]] | ||||
|             except Realm.DoesNotExist as e: | ||||
|                 raise CommandError(e) | ||||
|         else: | ||||
|             realms = Realm.objects.all() | ||||
|  | ||||
|         for realm in realms: | ||||
|             streams = Stream.objects.filter(realm=realm).exclude(Q(name__istartswith="tutorial-")) | ||||
|             # private stream count | ||||
|             private_count = 0 | ||||
|             # public stream count | ||||
|             public_count = 0 | ||||
|             for stream in streams: | ||||
|                 if stream.invite_only: | ||||
|                     private_count += 1 | ||||
|                 else: | ||||
|                     public_count += 1 | ||||
|             print("------------") | ||||
|             print(realm.string_id, end=" ") | ||||
|             print("{:>10} {} public streams and".format("(", public_count), end=" ") | ||||
|             print(f"{private_count} private streams )") | ||||
|             print("------------") | ||||
|             print("{:>25} {:>15} {:>10} {:>12}".format("stream", "subscribers", "messages", "type")) | ||||
|  | ||||
|             for stream in streams: | ||||
|                 if stream.invite_only: | ||||
|                     stream_type = "private" | ||||
|                 else: | ||||
|                     stream_type = "public" | ||||
|                 print(f"{stream.name:>25}", end=" ") | ||||
|                 recipient = Recipient.objects.filter(type=Recipient.STREAM, type_id=stream.id) | ||||
|                 print( | ||||
|                     "{:10}".format( | ||||
|                         len(Subscription.objects.filter(recipient=recipient, active=True)) | ||||
|                     ), | ||||
|                     end=" ", | ||||
|                 ) | ||||
|                 num_messages = len(Message.objects.filter(recipient=recipient)) | ||||
|                 print(f"{num_messages:12}", end=" ") | ||||
|                 print(f"{stream_type:>15}") | ||||
|             print("") | ||||
| @@ -1,27 +1,26 @@ | ||||
| import hashlib | ||||
| import os | ||||
| import time | ||||
| from argparse import ArgumentParser | ||||
| from datetime import timezone | ||||
| from typing import Any | ||||
| from typing import Any, Dict | ||||
|  | ||||
| from django.conf import settings | ||||
| from django.core.management.base import BaseCommand | ||||
| from django.utils.dateparse import parse_datetime | ||||
| from django.utils.timezone import now as timezone_now | ||||
| from typing_extensions import override | ||||
|  | ||||
| from analytics.lib.counts import ALL_COUNT_STATS, logger, process_count_stat | ||||
| from zerver.lib.management import ZulipBaseCommand, abort_unless_locked | ||||
| from zerver.lib.remote_server import send_server_data_to_push_bouncer, should_send_analytics_data | ||||
| from analytics.lib.counts import COUNT_STATS, logger, process_count_stat | ||||
| from scripts.lib.zulip_tools import ENDC, WARNING | ||||
| from zerver.lib.remote_server import send_analytics_to_remote_server | ||||
| from zerver.lib.timestamp import floor_to_hour | ||||
| from zerver.models import Realm | ||||
|  | ||||
|  | ||||
| class Command(ZulipBaseCommand): | ||||
| class Command(BaseCommand): | ||||
|     help = """Fills Analytics tables. | ||||
|  | ||||
|     Run as a cron job that runs every hour.""" | ||||
|  | ||||
|     @override | ||||
|     def add_arguments(self, parser: ArgumentParser) -> None: | ||||
|         parser.add_argument( | ||||
|             "--time", | ||||
| @@ -38,12 +37,22 @@ class Command(ZulipBaseCommand): | ||||
|             "--verbose", action="store_true", help="Print timing information to stdout." | ||||
|         ) | ||||
|  | ||||
|     @override | ||||
|     @abort_unless_locked | ||||
|     def handle(self, *args: Any, **options: Any) -> None: | ||||
|         self.run_update_analytics_counts(options) | ||||
|         try: | ||||
|             os.mkdir(settings.ANALYTICS_LOCK_DIR) | ||||
|         except OSError: | ||||
|             print( | ||||
|                 f"{WARNING}Analytics lock {settings.ANALYTICS_LOCK_DIR} is unavailable;" | ||||
|                 f" exiting.{ENDC}" | ||||
|             ) | ||||
|             return | ||||
|  | ||||
|     def run_update_analytics_counts(self, options: dict[str, Any]) -> None: | ||||
|         try: | ||||
|             self.run_update_analytics_counts(options) | ||||
|         finally: | ||||
|             os.rmdir(settings.ANALYTICS_LOCK_DIR) | ||||
|  | ||||
|     def run_update_analytics_counts(self, options: Dict[str, Any]) -> None: | ||||
|         # installation_epoch relies on there being at least one realm; we | ||||
|         # shouldn't run the analytics code if that condition isn't satisfied | ||||
|         if not Realm.objects.exists(): | ||||
| @@ -51,20 +60,19 @@ class Command(ZulipBaseCommand): | ||||
|             return | ||||
|  | ||||
|         fill_to_time = parse_datetime(options["time"]) | ||||
|         assert fill_to_time is not None | ||||
|         if options["utc"]: | ||||
|             fill_to_time = fill_to_time.replace(tzinfo=timezone.utc) | ||||
|         if fill_to_time.tzinfo is None: | ||||
|             raise ValueError( | ||||
|                 "--time must be time-zone-aware. Maybe you meant to use the --utc option?" | ||||
|                 "--time must be timezone aware. Maybe you meant to use the --utc option?" | ||||
|             ) | ||||
|  | ||||
|         fill_to_time = floor_to_hour(fill_to_time.astimezone(timezone.utc)) | ||||
|  | ||||
|         if options["stat"] is not None: | ||||
|             stats = [ALL_COUNT_STATS[options["stat"]]] | ||||
|             stats = [COUNT_STATS[options["stat"]]] | ||||
|         else: | ||||
|             stats = list(ALL_COUNT_STATS.values()) | ||||
|             stats = list(COUNT_STATS.values()) | ||||
|  | ||||
|         logger.info("Starting updating analytics counts through %s", fill_to_time) | ||||
|         if options["verbose"]: | ||||
| @@ -83,17 +91,5 @@ class Command(ZulipBaseCommand): | ||||
|             ) | ||||
|         logger.info("Finished updating analytics counts through %s", fill_to_time) | ||||
|  | ||||
|         if should_send_analytics_data(): | ||||
|             # Based on the specific value of the setting, the exact details to send | ||||
|             # will be decided. However, we proceed just based on this not being falsey. | ||||
|  | ||||
|             # Skew 0-10 minutes based on a hash of settings.ZULIP_ORG_ID, so | ||||
|             # that each server will report in at a somewhat consistent time. | ||||
|             assert settings.ZULIP_ORG_ID | ||||
|             delay = int.from_bytes( | ||||
|                 hashlib.sha256(settings.ZULIP_ORG_ID.encode()).digest(), byteorder="big" | ||||
|             ) % (60 * 10) | ||||
|             logger.info("Sleeping %d seconds before reporting...", delay) | ||||
|             time.sleep(delay) | ||||
|  | ||||
|             send_server_data_to_push_bouncer(consider_usage_statistics=True) | ||||
|         if settings.PUSH_NOTIFICATION_BOUNCER_URL and settings.SUBMIT_USAGE_STATISTICS: | ||||
|             send_analytics_to_remote_server() | ||||
|   | ||||
| @@ -4,6 +4,7 @@ from django.db import migrations, models | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("zerver", "0030_realm_org_type"), | ||||
|         migrations.swappable_dependency(settings.AUTH_USER_MODEL), | ||||
|   | ||||
| @@ -2,6 +2,7 @@ from django.db import migrations | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("analytics", "0001_initial"), | ||||
|     ] | ||||
|   | ||||
| @@ -2,6 +2,7 @@ from django.db import migrations, models | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("analytics", "0002_remove_huddlecount"), | ||||
|     ] | ||||
|   | ||||
| @@ -2,6 +2,7 @@ from django.db import migrations, models | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("analytics", "0003_fillstate"), | ||||
|     ] | ||||
|   | ||||
| @@ -2,6 +2,7 @@ from django.db import migrations, models | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("analytics", "0004_add_subgroup"), | ||||
|     ] | ||||
|   | ||||
| @@ -2,6 +2,7 @@ from django.db import migrations | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("analytics", "0005_alter_field_size"), | ||||
|     ] | ||||
|   | ||||
| @@ -3,6 +3,7 @@ from django.db import migrations | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("analytics", "0006_add_subgroup_to_unique_constraints"), | ||||
|     ] | ||||
|   | ||||
| @@ -1,33 +1,25 @@ | ||||
| # Generated by Django 1.10.5 on 2017-02-01 22:28 | ||||
| from django.db import migrations, models | ||||
| from django.db import migrations | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("zerver", "0050_userprofile_avatar_version"), | ||||
|         ("analytics", "0007_remove_interval"), | ||||
|     ] | ||||
|  | ||||
|     operations = [ | ||||
|         migrations.AddIndex( | ||||
|             model_name="realmcount", | ||||
|             index=models.Index( | ||||
|                 fields=["property", "end_time"], | ||||
|                 name="analytics_realmcount_property_end_time_3b60396b_idx", | ||||
|         migrations.AlterIndexTogether( | ||||
|             name="realmcount", | ||||
|             index_together={("property", "end_time")}, | ||||
|         ), | ||||
|         migrations.AlterIndexTogether( | ||||
|             name="streamcount", | ||||
|             index_together={("property", "realm", "end_time")}, | ||||
|         ), | ||||
|         migrations.AddIndex( | ||||
|             model_name="streamcount", | ||||
|             index=models.Index( | ||||
|                 fields=["property", "realm", "end_time"], | ||||
|                 name="analytics_streamcount_property_realm_id_end_time_155ae930_idx", | ||||
|             ), | ||||
|         ), | ||||
|         migrations.AddIndex( | ||||
|             model_name="usercount", | ||||
|             index=models.Index( | ||||
|                 fields=["property", "realm", "end_time"], | ||||
|                 name="analytics_usercount_property_realm_id_end_time_591dbec1_idx", | ||||
|             ), | ||||
|         migrations.AlterIndexTogether( | ||||
|             name="usercount", | ||||
|             index_together={("property", "realm", "end_time")}, | ||||
|         ), | ||||
|     ] | ||||
|   | ||||
| @@ -1,10 +1,10 @@ | ||||
| from django.db import migrations | ||||
| from django.db.backends.base.schema import BaseDatabaseSchemaEditor | ||||
| from django.db.backends.postgresql.schema import DatabaseSchemaEditor | ||||
| from django.db.migrations.state import StateApps | ||||
|  | ||||
|  | ||||
| def delete_messages_sent_to_stream_stat( | ||||
|     apps: StateApps, schema_editor: BaseDatabaseSchemaEditor | ||||
|     apps: StateApps, schema_editor: DatabaseSchemaEditor | ||||
| ) -> None: | ||||
|     UserCount = apps.get_model("analytics", "UserCount") | ||||
|     StreamCount = apps.get_model("analytics", "StreamCount") | ||||
| @@ -21,6 +21,7 @@ def delete_messages_sent_to_stream_stat( | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("analytics", "0008_add_count_indexes"), | ||||
|     ] | ||||
|   | ||||
| @@ -1,10 +1,10 @@ | ||||
| from django.db import migrations | ||||
| from django.db.backends.base.schema import BaseDatabaseSchemaEditor | ||||
| from django.db.backends.postgresql.schema import DatabaseSchemaEditor | ||||
| from django.db.migrations.state import StateApps | ||||
|  | ||||
|  | ||||
| def clear_message_sent_by_message_type_values( | ||||
|     apps: StateApps, schema_editor: BaseDatabaseSchemaEditor | ||||
|     apps: StateApps, schema_editor: DatabaseSchemaEditor | ||||
| ) -> None: | ||||
|     UserCount = apps.get_model("analytics", "UserCount") | ||||
|     StreamCount = apps.get_model("analytics", "StreamCount") | ||||
| @@ -21,6 +21,7 @@ def clear_message_sent_by_message_type_values( | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [("analytics", "0009_remove_messages_to_stream_stat")] | ||||
|  | ||||
|     operations = [ | ||||
|   | ||||
| @@ -1,9 +1,9 @@ | ||||
| from django.db import migrations | ||||
| from django.db.backends.base.schema import BaseDatabaseSchemaEditor | ||||
| from django.db.backends.postgresql.schema import DatabaseSchemaEditor | ||||
| from django.db.migrations.state import StateApps | ||||
|  | ||||
|  | ||||
| def clear_analytics_tables(apps: StateApps, schema_editor: BaseDatabaseSchemaEditor) -> None: | ||||
| def clear_analytics_tables(apps: StateApps, schema_editor: DatabaseSchemaEditor) -> None: | ||||
|     UserCount = apps.get_model("analytics", "UserCount") | ||||
|     StreamCount = apps.get_model("analytics", "StreamCount") | ||||
|     RealmCount = apps.get_model("analytics", "RealmCount") | ||||
| @@ -18,6 +18,7 @@ def clear_analytics_tables(apps: StateApps, schema_editor: BaseDatabaseSchemaEdi | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("analytics", "0010_clear_messages_sent_values"), | ||||
|     ] | ||||
|   | ||||
| @@ -5,6 +5,7 @@ from django.db import migrations, models | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("analytics", "0011_clear_analytics_tables"), | ||||
|     ] | ||||
|   | ||||
| @@ -4,6 +4,7 @@ from django.db import migrations | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("analytics", "0012_add_on_delete"), | ||||
|     ] | ||||
|   | ||||
| @@ -4,6 +4,7 @@ from django.db import migrations | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("analytics", "0013_remove_anomaly"), | ||||
|     ] | ||||
|   | ||||
| @@ -1,10 +1,10 @@ | ||||
| from django.db import migrations | ||||
| from django.db.backends.base.schema import BaseDatabaseSchemaEditor | ||||
| from django.db.backends.postgresql.schema import DatabaseSchemaEditor | ||||
| from django.db.migrations.state import StateApps | ||||
| from django.db.models import Count, Sum | ||||
|  | ||||
|  | ||||
| def clear_duplicate_counts(apps: StateApps, schema_editor: BaseDatabaseSchemaEditor) -> None: | ||||
| def clear_duplicate_counts(apps: StateApps, schema_editor: DatabaseSchemaEditor) -> None: | ||||
|     """This is a preparatory migration for our Analytics tables. | ||||
|  | ||||
|     The backstory is that Django's unique_together indexes do not properly | ||||
| @@ -55,6 +55,7 @@ def clear_duplicate_counts(apps: StateApps, schema_editor: BaseDatabaseSchemaEdi | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("analytics", "0014_remove_fillstate_last_modified"), | ||||
|     ] | ||||
|   | ||||
| @@ -4,6 +4,7 @@ from django.db import migrations, models | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("analytics", "0015_clear_duplicate_counts"), | ||||
|     ] | ||||
|   | ||||
| @@ -1,114 +0,0 @@ | ||||
| from django.db import migrations, models | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|     dependencies = [ | ||||
|         ("analytics", "0016_unique_constraint_when_subgroup_null"), | ||||
|     ] | ||||
|  | ||||
|     # If the server was installed between 7.0 and 7.4 (or main between | ||||
|     # 2c20028aa451 and 7807bff52635), it contains indexes which (when | ||||
|     # running 7.5 or 7807bff52635 or higher) are never used, because | ||||
|     # they contain an improper cast | ||||
|     # (https://code.djangoproject.com/ticket/34840). | ||||
|     # | ||||
|     # We regenerate the indexes here, by dropping and re-creating | ||||
|     # them, so that we know that they are properly formed. | ||||
|     operations = [ | ||||
|         migrations.RemoveConstraint( | ||||
|             model_name="installationcount", | ||||
|             name="unique_installation_count", | ||||
|         ), | ||||
|         migrations.AddConstraint( | ||||
|             model_name="installationcount", | ||||
|             constraint=models.UniqueConstraint( | ||||
|                 condition=models.Q(subgroup__isnull=False), | ||||
|                 fields=("property", "subgroup", "end_time"), | ||||
|                 name="unique_installation_count", | ||||
|             ), | ||||
|         ), | ||||
|         migrations.RemoveConstraint( | ||||
|             model_name="installationcount", | ||||
|             name="unique_installation_count_null_subgroup", | ||||
|         ), | ||||
|         migrations.AddConstraint( | ||||
|             model_name="installationcount", | ||||
|             constraint=models.UniqueConstraint( | ||||
|                 condition=models.Q(subgroup__isnull=True), | ||||
|                 fields=("property", "end_time"), | ||||
|                 name="unique_installation_count_null_subgroup", | ||||
|             ), | ||||
|         ), | ||||
|         migrations.RemoveConstraint( | ||||
|             model_name="realmcount", | ||||
|             name="unique_realm_count", | ||||
|         ), | ||||
|         migrations.AddConstraint( | ||||
|             model_name="realmcount", | ||||
|             constraint=models.UniqueConstraint( | ||||
|                 condition=models.Q(subgroup__isnull=False), | ||||
|                 fields=("realm", "property", "subgroup", "end_time"), | ||||
|                 name="unique_realm_count", | ||||
|             ), | ||||
|         ), | ||||
|         migrations.RemoveConstraint( | ||||
|             model_name="realmcount", | ||||
|             name="unique_realm_count_null_subgroup", | ||||
|         ), | ||||
|         migrations.AddConstraint( | ||||
|             model_name="realmcount", | ||||
|             constraint=models.UniqueConstraint( | ||||
|                 condition=models.Q(subgroup__isnull=True), | ||||
|                 fields=("realm", "property", "end_time"), | ||||
|                 name="unique_realm_count_null_subgroup", | ||||
|             ), | ||||
|         ), | ||||
|         migrations.RemoveConstraint( | ||||
|             model_name="streamcount", | ||||
|             name="unique_stream_count", | ||||
|         ), | ||||
|         migrations.AddConstraint( | ||||
|             model_name="streamcount", | ||||
|             constraint=models.UniqueConstraint( | ||||
|                 condition=models.Q(subgroup__isnull=False), | ||||
|                 fields=("stream", "property", "subgroup", "end_time"), | ||||
|                 name="unique_stream_count", | ||||
|             ), | ||||
|         ), | ||||
|         migrations.RemoveConstraint( | ||||
|             model_name="streamcount", | ||||
|             name="unique_stream_count_null_subgroup", | ||||
|         ), | ||||
|         migrations.AddConstraint( | ||||
|             model_name="streamcount", | ||||
|             constraint=models.UniqueConstraint( | ||||
|                 condition=models.Q(subgroup__isnull=True), | ||||
|                 fields=("stream", "property", "end_time"), | ||||
|                 name="unique_stream_count_null_subgroup", | ||||
|             ), | ||||
|         ), | ||||
|         migrations.RemoveConstraint( | ||||
|             model_name="usercount", | ||||
|             name="unique_user_count", | ||||
|         ), | ||||
|         migrations.AddConstraint( | ||||
|             model_name="usercount", | ||||
|             constraint=models.UniqueConstraint( | ||||
|                 condition=models.Q(subgroup__isnull=False), | ||||
|                 fields=("user", "property", "subgroup", "end_time"), | ||||
|                 name="unique_user_count", | ||||
|             ), | ||||
|         ), | ||||
|         migrations.RemoveConstraint( | ||||
|             model_name="usercount", | ||||
|             name="unique_user_count_null_subgroup", | ||||
|         ), | ||||
|         migrations.AddConstraint( | ||||
|             model_name="usercount", | ||||
|             constraint=models.UniqueConstraint( | ||||
|                 condition=models.Q(subgroup__isnull=True), | ||||
|                 fields=("user", "property", "end_time"), | ||||
|                 name="unique_user_count_null_subgroup", | ||||
|             ), | ||||
|         ), | ||||
|     ] | ||||
| @@ -1,15 +0,0 @@ | ||||
| from django.db import migrations | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|     elidable = True | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("analytics", "0017_regenerate_partial_indexes"), | ||||
|     ] | ||||
|  | ||||
|     operations = [ | ||||
|         migrations.RunSQL( | ||||
|             "DELETE FROM analytics_usercount WHERE property = 'active_users_audit:is_bot:day'" | ||||
|         ) | ||||
|     ] | ||||
| @@ -1,26 +0,0 @@ | ||||
| from django.db import migrations | ||||
|  | ||||
| REMOVED_COUNTS = ( | ||||
|     "active_users_log:is_bot:day", | ||||
|     "active_users:is_bot:day", | ||||
| ) | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|     elidable = True | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("analytics", "0018_remove_usercount_active_users_audit"), | ||||
|     ] | ||||
|  | ||||
|     operations = [ | ||||
|         migrations.RunSQL( | ||||
|             [ | ||||
|                 ("DELETE FROM analytics_realmcount WHERE property IN %s", (REMOVED_COUNTS,)), | ||||
|                 ( | ||||
|                     "DELETE FROM analytics_installationcount WHERE property IN %s", | ||||
|                     (REMOVED_COUNTS,), | ||||
|                 ), | ||||
|             ] | ||||
|         ) | ||||
|     ] | ||||
| @@ -1,40 +0,0 @@ | ||||
| from django.db import migrations, models | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|     atomic = False | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("analytics", "0019_remove_unused_counts"), | ||||
|     ] | ||||
|  | ||||
|     operations = [ | ||||
|         migrations.AlterField( | ||||
|             model_name="installationcount", | ||||
|             name="id", | ||||
|             field=models.BigAutoField( | ||||
|                 auto_created=True, primary_key=True, serialize=False, verbose_name="ID" | ||||
|             ), | ||||
|         ), | ||||
|         migrations.AlterField( | ||||
|             model_name="realmcount", | ||||
|             name="id", | ||||
|             field=models.BigAutoField( | ||||
|                 auto_created=True, primary_key=True, serialize=False, verbose_name="ID" | ||||
|             ), | ||||
|         ), | ||||
|         migrations.AlterField( | ||||
|             model_name="streamcount", | ||||
|             name="id", | ||||
|             field=models.BigAutoField( | ||||
|                 auto_created=True, primary_key=True, serialize=False, verbose_name="ID" | ||||
|             ), | ||||
|         ), | ||||
|         migrations.AlterField( | ||||
|             model_name="usercount", | ||||
|             name="id", | ||||
|             field=models.BigAutoField( | ||||
|                 auto_created=True, primary_key=True, serialize=False, verbose_name="ID" | ||||
|             ), | ||||
|         ), | ||||
|     ] | ||||
| @@ -1,17 +0,0 @@ | ||||
| from django.db import migrations, models | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|     dependencies = [ | ||||
|         ("analytics", "0020_alter_installationcount_id_alter_realmcount_id_and_more"), | ||||
|     ] | ||||
|  | ||||
|     operations = [ | ||||
|         migrations.AlterField( | ||||
|             model_name="fillstate", | ||||
|             name="id", | ||||
|             field=models.BigAutoField( | ||||
|                 auto_created=True, primary_key=True, serialize=False, verbose_name="ID" | ||||
|             ), | ||||
|         ), | ||||
|     ] | ||||
| @@ -1,33 +1,29 @@ | ||||
| # https://github.com/typeddjango/django-stubs/issues/1698 | ||||
| # mypy: disable-error-code="explicit-override" | ||||
|  | ||||
| from datetime import datetime | ||||
| import datetime | ||||
| from typing import Optional | ||||
|  | ||||
| from django.db import models | ||||
| from django.db.models import Q, UniqueConstraint | ||||
| from typing_extensions import override | ||||
|  | ||||
| from zerver.lib.timestamp import floor_to_day | ||||
| from zerver.models import Realm, Stream, UserProfile | ||||
|  | ||||
|  | ||||
| class FillState(models.Model): | ||||
|     property = models.CharField(max_length=40, unique=True) | ||||
|     end_time = models.DateTimeField() | ||||
|     property: str = models.CharField(max_length=40, unique=True) | ||||
|     end_time: datetime.datetime = models.DateTimeField() | ||||
|  | ||||
|     # Valid states are {DONE, STARTED} | ||||
|     DONE = 1 | ||||
|     STARTED = 2 | ||||
|     state = models.PositiveSmallIntegerField() | ||||
|     state: int = models.PositiveSmallIntegerField() | ||||
|  | ||||
|     @override | ||||
|     def __str__(self) -> str: | ||||
|         return f"{self.property} {self.end_time} {self.state}" | ||||
|         return f"<FillState: {self.property} {self.end_time} {self.state}>" | ||||
|  | ||||
|  | ||||
| # The earliest/starting end_time in FillState | ||||
| # We assume there is at least one realm | ||||
| def installation_epoch() -> datetime: | ||||
| def installation_epoch() -> datetime.datetime: | ||||
|     earliest_realm_creation = Realm.objects.aggregate(models.Min("date_created"))[ | ||||
|         "date_created__min" | ||||
|     ] | ||||
| @@ -38,10 +34,10 @@ class BaseCount(models.Model): | ||||
|     # Note: When inheriting from BaseCount, you may want to rearrange | ||||
|     # the order of the columns in the migration to make sure they | ||||
|     # match how you'd like the table to be arranged. | ||||
|     property = models.CharField(max_length=32) | ||||
|     subgroup = models.CharField(max_length=16, null=True) | ||||
|     end_time = models.DateTimeField() | ||||
|     value = models.BigIntegerField() | ||||
|     property: str = models.CharField(max_length=32) | ||||
|     subgroup: Optional[str] = models.CharField(max_length=16, null=True) | ||||
|     end_time: datetime.datetime = models.DateTimeField() | ||||
|     value: int = models.BigIntegerField() | ||||
|  | ||||
|     class Meta: | ||||
|         abstract = True | ||||
| @@ -63,9 +59,8 @@ class InstallationCount(BaseCount): | ||||
|             ), | ||||
|         ] | ||||
|  | ||||
|     @override | ||||
|     def __str__(self) -> str: | ||||
|         return f"{self.property} {self.subgroup} {self.value}" | ||||
|         return f"<InstallationCount: {self.property} {self.subgroup} {self.value}>" | ||||
|  | ||||
|  | ||||
| class RealmCount(BaseCount): | ||||
| @@ -85,16 +80,10 @@ class RealmCount(BaseCount): | ||||
|                 name="unique_realm_count_null_subgroup", | ||||
|             ), | ||||
|         ] | ||||
|         indexes = [ | ||||
|             models.Index( | ||||
|                 fields=["property", "end_time"], | ||||
|                 name="analytics_realmcount_property_end_time_3b60396b_idx", | ||||
|             ) | ||||
|         ] | ||||
|         index_together = ["property", "end_time"] | ||||
|  | ||||
|     @override | ||||
|     def __str__(self) -> str: | ||||
|         return f"{self.realm!r} {self.property} {self.subgroup} {self.value}" | ||||
|         return f"<RealmCount: {self.realm} {self.property} {self.subgroup} {self.value}>" | ||||
|  | ||||
|  | ||||
| class UserCount(BaseCount): | ||||
| @@ -117,16 +106,10 @@ class UserCount(BaseCount): | ||||
|         ] | ||||
|         # This index dramatically improves the performance of | ||||
|         # aggregating from users to realms | ||||
|         indexes = [ | ||||
|             models.Index( | ||||
|                 fields=["property", "realm", "end_time"], | ||||
|                 name="analytics_usercount_property_realm_id_end_time_591dbec1_idx", | ||||
|             ) | ||||
|         ] | ||||
|         index_together = ["property", "realm", "end_time"] | ||||
|  | ||||
|     @override | ||||
|     def __str__(self) -> str: | ||||
|         return f"{self.user!r} {self.property} {self.subgroup} {self.value}" | ||||
|         return f"<UserCount: {self.user} {self.property} {self.subgroup} {self.value}>" | ||||
|  | ||||
|  | ||||
| class StreamCount(BaseCount): | ||||
| @@ -149,13 +132,9 @@ class StreamCount(BaseCount): | ||||
|         ] | ||||
|         # This index dramatically improves the performance of | ||||
|         # aggregating from streams to realms | ||||
|         indexes = [ | ||||
|             models.Index( | ||||
|                 fields=["property", "realm", "end_time"], | ||||
|                 name="analytics_streamcount_property_realm_id_end_time_155ae930_idx", | ||||
|             ) | ||||
|         ] | ||||
|         index_together = ["property", "realm", "end_time"] | ||||
|  | ||||
|     @override | ||||
|     def __str__(self) -> str: | ||||
|         return f"{self.stream!r} {self.property} {self.subgroup} {self.value} {self.id}" | ||||
|         return ( | ||||
|             f"<StreamCount: {self.stream} {self.property} {self.subgroup} {self.value} {self.id}>" | ||||
|         ) | ||||
|   | ||||
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							| @@ -22,7 +22,7 @@ class TestFixtures(ZulipTestCase): | ||||
|             frequency=CountStat.HOUR, | ||||
|         ) | ||||
|         # test we get an array of the right length with frequency=CountStat.HOUR | ||||
|         self.assert_length(data, 24) | ||||
|         self.assertEqual(len(data), 24) | ||||
|         # test that growth doesn't affect the first data point | ||||
|         self.assertEqual(data[0], 2000) | ||||
|         # test that the last data point is growth times what it otherwise would be | ||||
|   | ||||
| @@ -1,689 +0,0 @@ | ||||
| from datetime import datetime, timedelta, timezone | ||||
|  | ||||
| from django.utils.timezone import now as timezone_now | ||||
| from typing_extensions import override | ||||
|  | ||||
| from analytics.lib.counts import COUNT_STATS, CountStat | ||||
| from analytics.lib.time_utils import time_range | ||||
| from analytics.models import FillState, RealmCount, StreamCount, UserCount | ||||
| from analytics.views.stats import rewrite_client_arrays, sort_by_totals, sort_client_labels | ||||
| from zerver.lib.test_classes import ZulipTestCase | ||||
| from zerver.lib.timestamp import ceiling_to_day, ceiling_to_hour, datetime_to_timestamp | ||||
| from zerver.models import Client | ||||
| from zerver.models.realms import get_realm | ||||
|  | ||||
|  | ||||
| class TestStatsEndpoint(ZulipTestCase): | ||||
|     def test_stats(self) -> None: | ||||
|         self.user = self.example_user("hamlet") | ||||
|         self.login_user(self.user) | ||||
|         result = self.client_get("/stats") | ||||
|         self.assertEqual(result.status_code, 200) | ||||
|         # Check that we get something back | ||||
|         self.assert_in_response("Zulip analytics for", result) | ||||
|  | ||||
|     def test_guest_user_cant_access_stats(self) -> None: | ||||
|         self.user = self.example_user("polonius") | ||||
|         self.login_user(self.user) | ||||
|         result = self.client_get("/stats") | ||||
|         self.assert_json_error(result, "Not allowed for guest users", 400) | ||||
|  | ||||
|         result = self.client_get("/json/analytics/chart_data") | ||||
|         self.assert_json_error(result, "Not allowed for guest users", 400) | ||||
|  | ||||
|     def test_stats_for_realm(self) -> None: | ||||
|         user = self.example_user("hamlet") | ||||
|         self.login_user(user) | ||||
|  | ||||
|         result = self.client_get("/stats/realm/zulip/") | ||||
|         self.assertEqual(result.status_code, 302) | ||||
|  | ||||
|         result = self.client_get("/stats/realm/not_existing_realm/") | ||||
|         self.assertEqual(result.status_code, 302) | ||||
|  | ||||
|         user = self.example_user("hamlet") | ||||
|         user.is_staff = True | ||||
|         user.save(update_fields=["is_staff"]) | ||||
|  | ||||
|         result = self.client_get("/stats/realm/not_existing_realm/") | ||||
|         self.assertEqual(result.status_code, 404) | ||||
|  | ||||
|         result = self.client_get("/stats/realm/zulip/") | ||||
|         self.assertEqual(result.status_code, 200) | ||||
|         self.assert_in_response("Zulip analytics for", result) | ||||
|  | ||||
|     def test_stats_for_installation(self) -> None: | ||||
|         user = self.example_user("hamlet") | ||||
|         self.login_user(user) | ||||
|  | ||||
|         result = self.client_get("/stats/installation") | ||||
|         self.assertEqual(result.status_code, 302) | ||||
|  | ||||
|         user = self.example_user("hamlet") | ||||
|         user.is_staff = True | ||||
|         user.save(update_fields=["is_staff"]) | ||||
|  | ||||
|         result = self.client_get("/stats/installation") | ||||
|         self.assertEqual(result.status_code, 200) | ||||
|         self.assert_in_response("Zulip analytics for", result) | ||||
|  | ||||
|  | ||||
| class TestGetChartData(ZulipTestCase): | ||||
|     @override | ||||
|     def setUp(self) -> None: | ||||
|         super().setUp() | ||||
|         self.realm = get_realm("zulip") | ||||
|         self.user = self.example_user("hamlet") | ||||
|         self.stream_id = self.get_stream_id(self.get_streams(self.user)[0]) | ||||
|         self.login_user(self.user) | ||||
|         self.end_times_hour = [ | ||||
|             ceiling_to_hour(self.realm.date_created) + timedelta(hours=i) for i in range(4) | ||||
|         ] | ||||
|         self.end_times_day = [ | ||||
|             ceiling_to_day(self.realm.date_created) + timedelta(days=i) for i in range(4) | ||||
|         ] | ||||
|  | ||||
|     def data(self, i: int) -> list[int]: | ||||
|         return [0, 0, i, 0] | ||||
|  | ||||
|     def insert_data( | ||||
|         self, stat: CountStat, realm_subgroups: list[str | None], user_subgroups: list[str] | ||||
|     ) -> None: | ||||
|         if stat.frequency == CountStat.HOUR: | ||||
|             insert_time = self.end_times_hour[2] | ||||
|             fill_time = self.end_times_hour[-1] | ||||
|         if stat.frequency == CountStat.DAY: | ||||
|             insert_time = self.end_times_day[2] | ||||
|             fill_time = self.end_times_day[-1] | ||||
|  | ||||
|         RealmCount.objects.bulk_create( | ||||
|             RealmCount( | ||||
|                 property=stat.property, | ||||
|                 subgroup=subgroup, | ||||
|                 end_time=insert_time, | ||||
|                 value=100 + i, | ||||
|                 realm=self.realm, | ||||
|             ) | ||||
|             for i, subgroup in enumerate(realm_subgroups) | ||||
|         ) | ||||
|         UserCount.objects.bulk_create( | ||||
|             UserCount( | ||||
|                 property=stat.property, | ||||
|                 subgroup=subgroup, | ||||
|                 end_time=insert_time, | ||||
|                 value=200 + i, | ||||
|                 realm=self.realm, | ||||
|                 user=self.user, | ||||
|             ) | ||||
|             for i, subgroup in enumerate(user_subgroups) | ||||
|         ) | ||||
|         StreamCount.objects.bulk_create( | ||||
|             StreamCount( | ||||
|                 property=stat.property, | ||||
|                 subgroup=subgroup, | ||||
|                 end_time=insert_time, | ||||
|                 value=100 + i, | ||||
|                 stream_id=self.stream_id, | ||||
|                 realm=self.realm, | ||||
|             ) | ||||
|             for i, subgroup in enumerate(realm_subgroups) | ||||
|         ) | ||||
|         FillState.objects.create(property=stat.property, end_time=fill_time, state=FillState.DONE) | ||||
|  | ||||
|     def test_number_of_humans(self) -> None: | ||||
|         stat = COUNT_STATS["realm_active_humans::day"] | ||||
|         self.insert_data(stat, [None], []) | ||||
|         stat = COUNT_STATS["1day_actives::day"] | ||||
|         self.insert_data(stat, [None], []) | ||||
|         stat = COUNT_STATS["active_users_audit:is_bot:day"] | ||||
|         self.insert_data(stat, ["false"], []) | ||||
|         result = self.client_get("/json/analytics/chart_data", {"chart_name": "number_of_humans"}) | ||||
|         data = self.assert_json_success(result) | ||||
|         self.assertEqual( | ||||
|             data, | ||||
|             { | ||||
|                 "msg": "", | ||||
|                 "end_times": [datetime_to_timestamp(dt) for dt in self.end_times_day], | ||||
|                 "frequency": CountStat.DAY, | ||||
|                 "everyone": { | ||||
|                     "_1day": self.data(100), | ||||
|                     "_15day": self.data(100), | ||||
|                     "all_time": self.data(100), | ||||
|                 }, | ||||
|                 "display_order": None, | ||||
|                 "result": "success", | ||||
|             }, | ||||
|         ) | ||||
|  | ||||
|     def test_messages_sent_over_time(self) -> None: | ||||
|         stat = COUNT_STATS["messages_sent:is_bot:hour"] | ||||
|         self.insert_data(stat, ["true", "false"], ["false"]) | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data", {"chart_name": "messages_sent_over_time"} | ||||
|         ) | ||||
|         data = self.assert_json_success(result) | ||||
|         self.assertEqual( | ||||
|             data, | ||||
|             { | ||||
|                 "msg": "", | ||||
|                 "end_times": [datetime_to_timestamp(dt) for dt in self.end_times_hour], | ||||
|                 "frequency": CountStat.HOUR, | ||||
|                 "everyone": {"bot": self.data(100), "human": self.data(101)}, | ||||
|                 "user": {"bot": self.data(0), "human": self.data(200)}, | ||||
|                 "display_order": None, | ||||
|                 "result": "success", | ||||
|             }, | ||||
|         ) | ||||
|  | ||||
|     def test_messages_sent_by_message_type(self) -> None: | ||||
|         stat = COUNT_STATS["messages_sent:message_type:day"] | ||||
|         self.insert_data( | ||||
|             stat, ["public_stream", "private_message"], ["public_stream", "private_stream"] | ||||
|         ) | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data", {"chart_name": "messages_sent_by_message_type"} | ||||
|         ) | ||||
|         data = self.assert_json_success(result) | ||||
|         self.assertEqual( | ||||
|             data, | ||||
|             { | ||||
|                 "msg": "", | ||||
|                 "end_times": [datetime_to_timestamp(dt) for dt in self.end_times_day], | ||||
|                 "frequency": CountStat.DAY, | ||||
|                 "everyone": { | ||||
|                     "Public channels": self.data(100), | ||||
|                     "Private channels": self.data(0), | ||||
|                     "Direct messages": self.data(101), | ||||
|                     "Group direct messages": self.data(0), | ||||
|                 }, | ||||
|                 "user": { | ||||
|                     "Public channels": self.data(200), | ||||
|                     "Private channels": self.data(201), | ||||
|                     "Direct messages": self.data(0), | ||||
|                     "Group direct messages": self.data(0), | ||||
|                 }, | ||||
|                 "display_order": [ | ||||
|                     "Direct messages", | ||||
|                     "Public channels", | ||||
|                     "Private channels", | ||||
|                     "Group direct messages", | ||||
|                 ], | ||||
|                 "result": "success", | ||||
|             }, | ||||
|         ) | ||||
|  | ||||
|     def test_messages_sent_by_client(self) -> None: | ||||
|         stat = COUNT_STATS["messages_sent:client:day"] | ||||
|         client1 = Client.objects.create(name="client 1") | ||||
|         client2 = Client.objects.create(name="client 2") | ||||
|         client3 = Client.objects.create(name="client 3") | ||||
|         client4 = Client.objects.create(name="client 4") | ||||
|         self.insert_data( | ||||
|             stat, | ||||
|             [str(client4.id), str(client3.id), str(client2.id)], | ||||
|             [str(client3.id), str(client1.id)], | ||||
|         ) | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data", {"chart_name": "messages_sent_by_client"} | ||||
|         ) | ||||
|         data = self.assert_json_success(result) | ||||
|         self.assertEqual( | ||||
|             data, | ||||
|             { | ||||
|                 "msg": "", | ||||
|                 "end_times": [datetime_to_timestamp(dt) for dt in self.end_times_day], | ||||
|                 "frequency": CountStat.DAY, | ||||
|                 "everyone": { | ||||
|                     "client 4": self.data(100), | ||||
|                     "client 3": self.data(101), | ||||
|                     "client 2": self.data(102), | ||||
|                 }, | ||||
|                 "user": {"client 3": self.data(200), "client 1": self.data(201)}, | ||||
|                 "display_order": ["client 1", "client 2", "client 3", "client 4"], | ||||
|                 "result": "success", | ||||
|             }, | ||||
|         ) | ||||
|  | ||||
|     def test_messages_read_over_time(self) -> None: | ||||
|         stat = COUNT_STATS["messages_read::hour"] | ||||
|         self.insert_data(stat, [None], []) | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data", {"chart_name": "messages_read_over_time"} | ||||
|         ) | ||||
|         data = self.assert_json_success(result) | ||||
|         self.assertEqual( | ||||
|             data, | ||||
|             { | ||||
|                 "msg": "", | ||||
|                 "end_times": [datetime_to_timestamp(dt) for dt in self.end_times_hour], | ||||
|                 "frequency": CountStat.HOUR, | ||||
|                 "everyone": {"read": self.data(100)}, | ||||
|                 "user": {"read": self.data(0)}, | ||||
|                 "display_order": None, | ||||
|                 "result": "success", | ||||
|             }, | ||||
|         ) | ||||
|  | ||||
|     def test_messages_sent_by_stream(self) -> None: | ||||
|         stat = COUNT_STATS["messages_in_stream:is_bot:day"] | ||||
|         self.insert_data(stat, ["true", "false"], []) | ||||
|  | ||||
|         result = self.client_get( | ||||
|             f"/json/analytics/chart_data/stream/{self.stream_id}", | ||||
|             { | ||||
|                 "chart_name": "messages_sent_by_stream", | ||||
|             }, | ||||
|         ) | ||||
|         data = self.assert_json_success(result) | ||||
|         self.assertEqual( | ||||
|             data, | ||||
|             { | ||||
|                 "msg": "", | ||||
|                 "end_times": [datetime_to_timestamp(dt) for dt in self.end_times_day], | ||||
|                 "frequency": CountStat.DAY, | ||||
|                 "everyone": {"bot": self.data(100), "human": self.data(101)}, | ||||
|                 "display_order": None, | ||||
|                 "result": "success", | ||||
|             }, | ||||
|         ) | ||||
|  | ||||
|         result = self.api_get( | ||||
|             self.example_user("polonius"), | ||||
|             f"/api/v1/analytics/chart_data/stream/{self.stream_id}", | ||||
|             { | ||||
|                 "chart_name": "messages_sent_by_stream", | ||||
|             }, | ||||
|         ) | ||||
|         self.assert_json_error(result, "Not allowed for guest users") | ||||
|  | ||||
|         # Verify we correctly forbid access to stats of streams in other realms. | ||||
|         result = self.api_get( | ||||
|             self.mit_user("sipbtest"), | ||||
|             f"/api/v1/analytics/chart_data/stream/{self.stream_id}", | ||||
|             { | ||||
|                 "chart_name": "messages_sent_by_stream", | ||||
|             }, | ||||
|             subdomain="zephyr", | ||||
|         ) | ||||
|         self.assert_json_error(result, "Invalid channel ID") | ||||
|  | ||||
|     def test_include_empty_subgroups(self) -> None: | ||||
|         FillState.objects.create( | ||||
|             property="realm_active_humans::day", | ||||
|             end_time=self.end_times_day[0], | ||||
|             state=FillState.DONE, | ||||
|         ) | ||||
|         result = self.client_get("/json/analytics/chart_data", {"chart_name": "number_of_humans"}) | ||||
|         data = self.assert_json_success(result) | ||||
|         self.assertEqual(data["everyone"], {"_1day": [0], "_15day": [0], "all_time": [0]}) | ||||
|         self.assertFalse("user" in data) | ||||
|  | ||||
|         FillState.objects.create( | ||||
|             property="messages_sent:is_bot:hour", | ||||
|             end_time=self.end_times_hour[0], | ||||
|             state=FillState.DONE, | ||||
|         ) | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data", {"chart_name": "messages_sent_over_time"} | ||||
|         ) | ||||
|         data = self.assert_json_success(result) | ||||
|         self.assertEqual(data["everyone"], {"human": [0], "bot": [0]}) | ||||
|         self.assertEqual(data["user"], {"human": [0], "bot": [0]}) | ||||
|  | ||||
|         FillState.objects.create( | ||||
|             property="messages_sent:message_type:day", | ||||
|             end_time=self.end_times_day[0], | ||||
|             state=FillState.DONE, | ||||
|         ) | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data", {"chart_name": "messages_sent_by_message_type"} | ||||
|         ) | ||||
|         data = self.assert_json_success(result) | ||||
|         self.assertEqual( | ||||
|             data["everyone"], | ||||
|             { | ||||
|                 "Public channels": [0], | ||||
|                 "Private channels": [0], | ||||
|                 "Direct messages": [0], | ||||
|                 "Group direct messages": [0], | ||||
|             }, | ||||
|         ) | ||||
|         self.assertEqual( | ||||
|             data["user"], | ||||
|             { | ||||
|                 "Public channels": [0], | ||||
|                 "Private channels": [0], | ||||
|                 "Direct messages": [0], | ||||
|                 "Group direct messages": [0], | ||||
|             }, | ||||
|         ) | ||||
|  | ||||
|         FillState.objects.create( | ||||
|             property="messages_sent:client:day", | ||||
|             end_time=self.end_times_day[0], | ||||
|             state=FillState.DONE, | ||||
|         ) | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data", {"chart_name": "messages_sent_by_client"} | ||||
|         ) | ||||
|         data = self.assert_json_success(result) | ||||
|         self.assertEqual(data["everyone"], {}) | ||||
|         self.assertEqual(data["user"], {}) | ||||
|  | ||||
|     def test_start_and_end(self) -> None: | ||||
|         stat = COUNT_STATS["realm_active_humans::day"] | ||||
|         self.insert_data(stat, [None], []) | ||||
|         stat = COUNT_STATS["1day_actives::day"] | ||||
|         self.insert_data(stat, [None], []) | ||||
|         stat = COUNT_STATS["active_users_audit:is_bot:day"] | ||||
|         self.insert_data(stat, ["false"], []) | ||||
|         end_time_timestamps = [datetime_to_timestamp(dt) for dt in self.end_times_day] | ||||
|  | ||||
|         # valid start and end | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data", | ||||
|             { | ||||
|                 "chart_name": "number_of_humans", | ||||
|                 "start": end_time_timestamps[1], | ||||
|                 "end": end_time_timestamps[2], | ||||
|             }, | ||||
|         ) | ||||
|         data = self.assert_json_success(result) | ||||
|         self.assertEqual(data["end_times"], end_time_timestamps[1:3]) | ||||
|         self.assertEqual( | ||||
|             data["everyone"], {"_1day": [0, 100], "_15day": [0, 100], "all_time": [0, 100]} | ||||
|         ) | ||||
|  | ||||
|         # start later then end | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data", | ||||
|             { | ||||
|                 "chart_name": "number_of_humans", | ||||
|                 "start": end_time_timestamps[2], | ||||
|                 "end": end_time_timestamps[1], | ||||
|             }, | ||||
|         ) | ||||
|         self.assert_json_error_contains(result, "Start time is later than") | ||||
|  | ||||
|     def test_min_length(self) -> None: | ||||
|         stat = COUNT_STATS["realm_active_humans::day"] | ||||
|         self.insert_data(stat, [None], []) | ||||
|         stat = COUNT_STATS["1day_actives::day"] | ||||
|         self.insert_data(stat, [None], []) | ||||
|         stat = COUNT_STATS["active_users_audit:is_bot:day"] | ||||
|         self.insert_data(stat, ["false"], []) | ||||
|         # test min_length is too short to change anything | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data", {"chart_name": "number_of_humans", "min_length": 2} | ||||
|         ) | ||||
|         data = self.assert_json_success(result) | ||||
|         self.assertEqual( | ||||
|             data["end_times"], [datetime_to_timestamp(dt) for dt in self.end_times_day] | ||||
|         ) | ||||
|         self.assertEqual( | ||||
|             data["everyone"], | ||||
|             {"_1day": self.data(100), "_15day": self.data(100), "all_time": self.data(100)}, | ||||
|         ) | ||||
|         # test min_length larger than filled data | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data", {"chart_name": "number_of_humans", "min_length": 5} | ||||
|         ) | ||||
|         data = self.assert_json_success(result) | ||||
|         end_times = [ | ||||
|             ceiling_to_day(self.realm.date_created) + timedelta(days=i) for i in range(-1, 4) | ||||
|         ] | ||||
|         self.assertEqual(data["end_times"], [datetime_to_timestamp(dt) for dt in end_times]) | ||||
|         self.assertEqual( | ||||
|             data["everyone"], | ||||
|             { | ||||
|                 "_1day": [0, *self.data(100)], | ||||
|                 "_15day": [0, *self.data(100)], | ||||
|                 "all_time": [0, *self.data(100)], | ||||
|             }, | ||||
|         ) | ||||
|  | ||||
|     def test_non_existent_chart(self) -> None: | ||||
|         result = self.client_get("/json/analytics/chart_data", {"chart_name": "does_not_exist"}) | ||||
|         self.assert_json_error_contains(result, "Unknown chart name") | ||||
|  | ||||
|     def test_analytics_not_running(self) -> None: | ||||
|         realm = get_realm("zulip") | ||||
|  | ||||
|         self.assertEqual(FillState.objects.count(), 0) | ||||
|  | ||||
|         realm.date_created = timezone_now() - timedelta(days=3) | ||||
|         realm.save(update_fields=["date_created"]) | ||||
|         with self.assertLogs(level="WARNING") as m: | ||||
|             result = self.client_get( | ||||
|                 "/json/analytics/chart_data", {"chart_name": "messages_sent_over_time"} | ||||
|             ) | ||||
|             self.assertEqual( | ||||
|                 m.output, | ||||
|                 [ | ||||
|                     f"WARNING:root:User from realm zulip attempted to access /stats, but the computed start time: {realm.date_created} (creation of realm or installation) is later than the computed end time: 0001-01-01 00:00:00+00:00 (last successful analytics update). Is the analytics cron job running?" | ||||
|                 ], | ||||
|             ) | ||||
|  | ||||
|         self.assert_json_error_contains(result, "No analytics data available") | ||||
|  | ||||
|         realm.date_created = timezone_now() - timedelta(days=1, hours=2) | ||||
|         realm.save(update_fields=["date_created"]) | ||||
|         with self.assertLogs(level="WARNING") as m: | ||||
|             result = self.client_get( | ||||
|                 "/json/analytics/chart_data", {"chart_name": "messages_sent_over_time"} | ||||
|             ) | ||||
|             self.assertEqual( | ||||
|                 m.output, | ||||
|                 [ | ||||
|                     f"WARNING:root:User from realm zulip attempted to access /stats, but the computed start time: {realm.date_created} (creation of realm or installation) is later than the computed end time: 0001-01-01 00:00:00+00:00 (last successful analytics update). Is the analytics cron job running?" | ||||
|                 ], | ||||
|             ) | ||||
|  | ||||
|         self.assert_json_error_contains(result, "No analytics data available") | ||||
|  | ||||
|         realm.date_created = timezone_now() - timedelta(days=1, minutes=10) | ||||
|         realm.save(update_fields=["date_created"]) | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data", {"chart_name": "messages_sent_over_time"} | ||||
|         ) | ||||
|         self.assert_json_success(result) | ||||
|  | ||||
|         realm.date_created = timezone_now() - timedelta(hours=10) | ||||
|         realm.save(update_fields=["date_created"]) | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data", {"chart_name": "messages_sent_over_time"} | ||||
|         ) | ||||
|         self.assert_json_success(result) | ||||
|  | ||||
|         end_time = timezone_now() - timedelta(days=5) | ||||
|         fill_state = FillState.objects.create( | ||||
|             property="messages_sent:is_bot:hour", end_time=end_time, state=FillState.DONE | ||||
|         ) | ||||
|  | ||||
|         realm.date_created = timezone_now() - timedelta(days=3) | ||||
|         realm.save(update_fields=["date_created"]) | ||||
|         with self.assertLogs(level="WARNING") as m: | ||||
|             result = self.client_get( | ||||
|                 "/json/analytics/chart_data", {"chart_name": "messages_sent_over_time"} | ||||
|             ) | ||||
|             self.assertEqual( | ||||
|                 m.output, | ||||
|                 [ | ||||
|                     f"WARNING:root:User from realm zulip attempted to access /stats, but the computed start time: {realm.date_created} (creation of realm or installation) is later than the computed end time: {end_time} (last successful analytics update). Is the analytics cron job running?" | ||||
|                 ], | ||||
|             ) | ||||
|  | ||||
|         self.assert_json_error_contains(result, "No analytics data available") | ||||
|  | ||||
|         realm.date_created = timezone_now() - timedelta(days=1, minutes=10) | ||||
|         realm.save(update_fields=["date_created"]) | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data", {"chart_name": "messages_sent_over_time"} | ||||
|         ) | ||||
|         self.assert_json_success(result) | ||||
|  | ||||
|         end_time = timezone_now() - timedelta(days=2) | ||||
|         fill_state.end_time = end_time | ||||
|         fill_state.save(update_fields=["end_time"]) | ||||
|  | ||||
|         realm.date_created = timezone_now() - timedelta(days=3) | ||||
|         realm.save(update_fields=["date_created"]) | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data", {"chart_name": "messages_sent_over_time"} | ||||
|         ) | ||||
|         self.assert_json_success(result) | ||||
|  | ||||
|         realm.date_created = timezone_now() - timedelta(days=1, hours=2) | ||||
|         realm.save(update_fields=["date_created"]) | ||||
|         with self.assertLogs(level="WARNING") as m: | ||||
|             result = self.client_get( | ||||
|                 "/json/analytics/chart_data", {"chart_name": "messages_sent_over_time"} | ||||
|             ) | ||||
|             self.assertEqual( | ||||
|                 m.output, | ||||
|                 [ | ||||
|                     f"WARNING:root:User from realm zulip attempted to access /stats, but the computed start time: {realm.date_created} (creation of realm or installation) is later than the computed end time: {end_time} (last successful analytics update). Is the analytics cron job running?" | ||||
|                 ], | ||||
|             ) | ||||
|  | ||||
|         self.assert_json_error_contains(result, "No analytics data available") | ||||
|  | ||||
|         realm.date_created = timezone_now() - timedelta(days=1, minutes=10) | ||||
|         realm.save(update_fields=["date_created"]) | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data", {"chart_name": "messages_sent_over_time"} | ||||
|         ) | ||||
|         self.assert_json_success(result) | ||||
|  | ||||
|     def test_get_chart_data_for_realm(self) -> None: | ||||
|         user = self.example_user("hamlet") | ||||
|         self.login_user(user) | ||||
|  | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data/realm/zulip", {"chart_name": "number_of_humans"} | ||||
|         ) | ||||
|         self.assert_json_error(result, "Must be an server administrator", 400) | ||||
|  | ||||
|         user = self.example_user("hamlet") | ||||
|         user.is_staff = True | ||||
|         user.save(update_fields=["is_staff"]) | ||||
|         stat = COUNT_STATS["realm_active_humans::day"] | ||||
|         self.insert_data(stat, [None], []) | ||||
|  | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data/realm/not_existing_realm", | ||||
|             {"chart_name": "number_of_humans"}, | ||||
|         ) | ||||
|         self.assert_json_error(result, "Invalid organization", 400) | ||||
|  | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data/realm/zulip", {"chart_name": "number_of_humans"} | ||||
|         ) | ||||
|         self.assert_json_success(result) | ||||
|  | ||||
|     def test_get_chart_data_for_installation(self) -> None: | ||||
|         user = self.example_user("hamlet") | ||||
|         self.login_user(user) | ||||
|  | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data/installation", {"chart_name": "number_of_humans"} | ||||
|         ) | ||||
|         self.assert_json_error(result, "Must be an server administrator", 400) | ||||
|  | ||||
|         user = self.example_user("hamlet") | ||||
|         user.is_staff = True | ||||
|         user.save(update_fields=["is_staff"]) | ||||
|         stat = COUNT_STATS["realm_active_humans::day"] | ||||
|         self.insert_data(stat, [None], []) | ||||
|  | ||||
|         result = self.client_get( | ||||
|             "/json/analytics/chart_data/installation", {"chart_name": "number_of_humans"} | ||||
|         ) | ||||
|         self.assert_json_success(result) | ||||
|  | ||||
|  | ||||
| class TestGetChartDataHelpers(ZulipTestCase): | ||||
|     def test_sort_by_totals(self) -> None: | ||||
|         empty: list[int] = [] | ||||
|         value_arrays = {"c": [0, 1], "a": [9], "b": [1, 1, 1], "d": empty} | ||||
|         self.assertEqual(sort_by_totals(value_arrays), ["a", "b", "c", "d"]) | ||||
|  | ||||
|     def test_sort_client_labels(self) -> None: | ||||
|         data = { | ||||
|             "everyone": {"a": [16], "c": [15], "b": [14], "e": [13], "d": [12], "h": [11]}, | ||||
|             "user": {"a": [6], "b": [5], "d": [4], "e": [3], "f": [2], "g": [1]}, | ||||
|         } | ||||
|         self.assertEqual(sort_client_labels(data), ["a", "b", "c", "d", "e", "f", "g", "h"]) | ||||
|  | ||||
|  | ||||
| class TestTimeRange(ZulipTestCase): | ||||
|     def test_time_range(self) -> None: | ||||
|         HOUR = timedelta(hours=1) | ||||
|         DAY = timedelta(days=1) | ||||
|  | ||||
|         a_time = datetime(2016, 3, 14, 22, 59, tzinfo=timezone.utc) | ||||
|         floor_hour = datetime(2016, 3, 14, 22, tzinfo=timezone.utc) | ||||
|         floor_day = datetime(2016, 3, 14, tzinfo=timezone.utc) | ||||
|  | ||||
|         # test start == end | ||||
|         self.assertEqual(time_range(a_time, a_time, CountStat.HOUR, None), []) | ||||
|         self.assertEqual(time_range(a_time, a_time, CountStat.DAY, None), []) | ||||
|         # test start == end == boundary, and min_length == 0 | ||||
|         self.assertEqual(time_range(floor_hour, floor_hour, CountStat.HOUR, 0), [floor_hour]) | ||||
|         self.assertEqual(time_range(floor_day, floor_day, CountStat.DAY, 0), [floor_day]) | ||||
|         # test start and end on different boundaries | ||||
|         self.assertEqual( | ||||
|             time_range(floor_hour, floor_hour + HOUR, CountStat.HOUR, None), | ||||
|             [floor_hour, floor_hour + HOUR], | ||||
|         ) | ||||
|         self.assertEqual( | ||||
|             time_range(floor_day, floor_day + DAY, CountStat.DAY, None), | ||||
|             [floor_day, floor_day + DAY], | ||||
|         ) | ||||
|         # test min_length | ||||
|         self.assertEqual( | ||||
|             time_range(floor_hour, floor_hour + HOUR, CountStat.HOUR, 4), | ||||
|             [floor_hour - 2 * HOUR, floor_hour - HOUR, floor_hour, floor_hour + HOUR], | ||||
|         ) | ||||
|         self.assertEqual( | ||||
|             time_range(floor_day, floor_day + DAY, CountStat.DAY, 4), | ||||
|             [floor_day - 2 * DAY, floor_day - DAY, floor_day, floor_day + DAY], | ||||
|         ) | ||||
|  | ||||
|  | ||||
| class TestMapArrays(ZulipTestCase): | ||||
|     def test_map_arrays(self) -> None: | ||||
|         a = { | ||||
|             "desktop app 1.0": [1, 2, 3], | ||||
|             "desktop app 2.0": [10, 12, 13], | ||||
|             "desktop app 3.0": [21, 22, 23], | ||||
|             "website": [1, 2, 3], | ||||
|             "ZulipiOS": [1, 2, 3], | ||||
|             "ZulipElectron": [2, 5, 7], | ||||
|             "ZulipMobile": [1, 2, 3], | ||||
|             "ZulipMobile/flutter": [1, 1, 1], | ||||
|             "ZulipFlutter": [1, 1, 1], | ||||
|             "ZulipPython": [1, 2, 3], | ||||
|             "API: Python": [1, 2, 3], | ||||
|             "SomethingRandom": [4, 5, 6], | ||||
|             "ZulipGitHubWebhook": [7, 7, 9], | ||||
|             "ZulipAndroid": [64, 63, 65], | ||||
|             "ZulipTerminal": [9, 10, 11], | ||||
|         } | ||||
|         result = rewrite_client_arrays(a) | ||||
|         self.assertEqual( | ||||
|             result, | ||||
|             { | ||||
|                 "Old desktop app": [32, 36, 39], | ||||
|                 "Old iOS app": [1, 2, 3], | ||||
|                 "Desktop app": [2, 5, 7], | ||||
|                 "Mobile app (React Native)": [1, 2, 3], | ||||
|                 "Mobile app beta (Flutter)": [2, 2, 2], | ||||
|                 "Web app": [1, 2, 3], | ||||
|                 "Python API": [2, 4, 6], | ||||
|                 "SomethingRandom": [4, 5, 6], | ||||
|                 "GitHub webhook": [7, 7, 9], | ||||
|                 "Old Android app": [64, 63, 65], | ||||
|                 "Terminal app": [9, 10, 11], | ||||
|             }, | ||||
|         ) | ||||
							
								
								
									
										1214
									
								
								analytics/tests/test_views.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										1214
									
								
								analytics/tests/test_views.py
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							| @@ -1,36 +1,38 @@ | ||||
| from django.conf import settings | ||||
| from django.conf.urls import include | ||||
| from django.urls import path | ||||
| from django.urls.resolvers import URLPattern, URLResolver | ||||
|  | ||||
| from analytics.views.stats import ( | ||||
| from analytics.views import ( | ||||
|     get_activity, | ||||
|     get_chart_data, | ||||
|     get_chart_data_for_installation, | ||||
|     get_chart_data_for_realm, | ||||
|     get_chart_data_for_stream, | ||||
|     get_chart_data_for_remote_installation, | ||||
|     get_chart_data_for_remote_realm, | ||||
|     get_realm_activity, | ||||
|     get_user_activity, | ||||
|     stats, | ||||
|     stats_for_installation, | ||||
|     stats_for_realm, | ||||
|     stats_for_remote_installation, | ||||
|     stats_for_remote_realm, | ||||
|     support, | ||||
| ) | ||||
| from zerver.lib.rest import rest_path | ||||
|  | ||||
| i18n_urlpatterns: list[URLPattern | URLResolver] = [ | ||||
| i18n_urlpatterns = [ | ||||
|     # Server admin (user_profile.is_staff) visible stats pages | ||||
|     path("activity", get_activity), | ||||
|     path("activity/support", support, name="support"), | ||||
|     path("realm_activity/<realm_str>/", get_realm_activity), | ||||
|     path("user_activity/<email>/", get_user_activity), | ||||
|     path("stats/realm/<realm_str>/", stats_for_realm), | ||||
|     path("stats/installation", stats_for_installation), | ||||
|     # User-visible stats page | ||||
|     path("stats", stats, name="stats"), | ||||
| ] | ||||
|  | ||||
| if settings.ZILENCER_ENABLED: | ||||
|     from analytics.views.stats import stats_for_remote_installation, stats_for_remote_realm | ||||
|  | ||||
|     i18n_urlpatterns += [ | ||||
|     path("stats/remote/<int:remote_server_id>/installation", stats_for_remote_installation), | ||||
|     path( | ||||
|             "stats/remote/<int:remote_server_id>/realm/<int:remote_realm_id>/", | ||||
|             stats_for_remote_realm, | ||||
|         "stats/remote/<int:remote_server_id>/realm/<int:remote_realm_id>/", stats_for_remote_realm | ||||
|     ), | ||||
|     # User-visible stats page | ||||
|     path("stats", stats, name="stats"), | ||||
| ] | ||||
|  | ||||
| # These endpoints are a part of the API (V1), which uses: | ||||
| @@ -44,18 +46,8 @@ if settings.ZILENCER_ENABLED: | ||||
| v1_api_and_json_patterns = [ | ||||
|     # get data for the graphs at /stats | ||||
|     rest_path("analytics/chart_data", GET=get_chart_data), | ||||
|     rest_path("analytics/chart_data/stream/<stream_id>", GET=get_chart_data_for_stream), | ||||
|     rest_path("analytics/chart_data/realm/<realm_str>", GET=get_chart_data_for_realm), | ||||
|     rest_path("analytics/chart_data/installation", GET=get_chart_data_for_installation), | ||||
| ] | ||||
|  | ||||
| if settings.ZILENCER_ENABLED: | ||||
|     from analytics.views.stats import ( | ||||
|         get_chart_data_for_remote_installation, | ||||
|         get_chart_data_for_remote_realm, | ||||
|     ) | ||||
|  | ||||
|     v1_api_and_json_patterns += [ | ||||
|     rest_path( | ||||
|         "analytics/chart_data/remote/<int:remote_server_id>/installation", | ||||
|         GET=get_chart_data_for_remote_installation, | ||||
|   | ||||
							
								
								
									
										1791
									
								
								analytics/views.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										1791
									
								
								analytics/views.py
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							| @@ -1,575 +0,0 @@ | ||||
| import logging | ||||
| from collections import defaultdict | ||||
| from datetime import datetime, timedelta, timezone | ||||
| from typing import Any, Optional, TypeAlias, TypeVar, cast | ||||
|  | ||||
| from django.conf import settings | ||||
| from django.db.models import QuerySet | ||||
| from django.http import HttpRequest, HttpResponse, HttpResponseNotFound | ||||
| from django.shortcuts import render | ||||
| from django.utils import translation | ||||
| from django.utils.timezone import now as timezone_now | ||||
| from django.utils.translation import gettext as _ | ||||
|  | ||||
| from analytics.lib.counts import COUNT_STATS, CountStat | ||||
| from analytics.lib.time_utils import time_range | ||||
| from analytics.models import ( | ||||
|     BaseCount, | ||||
|     InstallationCount, | ||||
|     RealmCount, | ||||
|     StreamCount, | ||||
|     UserCount, | ||||
|     installation_epoch, | ||||
| ) | ||||
| from zerver.decorator import ( | ||||
|     require_non_guest_user, | ||||
|     require_server_admin, | ||||
|     require_server_admin_api, | ||||
|     to_utc_datetime, | ||||
|     zulip_login_required, | ||||
| ) | ||||
| from zerver.lib.exceptions import JsonableError | ||||
| from zerver.lib.i18n import get_and_set_request_language, get_language_translation_data | ||||
| from zerver.lib.request import REQ, has_request_variables | ||||
| from zerver.lib.response import json_success | ||||
| from zerver.lib.streams import access_stream_by_id | ||||
| from zerver.lib.timestamp import convert_to_UTC | ||||
| from zerver.lib.validator import to_non_negative_int | ||||
| from zerver.models import Client, Realm, Stream, UserProfile | ||||
| from zerver.models.realms import get_realm | ||||
|  | ||||
| if settings.ZILENCER_ENABLED: | ||||
|     from zilencer.models import RemoteInstallationCount, RemoteRealmCount, RemoteZulipServer | ||||
|  | ||||
| MAX_TIME_FOR_FULL_ANALYTICS_GENERATION = timedelta(days=1, minutes=30) | ||||
|  | ||||
|  | ||||
| def is_analytics_ready(realm: Realm) -> bool: | ||||
|     return (timezone_now() - realm.date_created) > MAX_TIME_FOR_FULL_ANALYTICS_GENERATION | ||||
|  | ||||
|  | ||||
| def render_stats( | ||||
|     request: HttpRequest, | ||||
|     data_url_suffix: str, | ||||
|     realm: Realm | None, | ||||
|     *, | ||||
|     title: str | None = None, | ||||
|     analytics_ready: bool = True, | ||||
| ) -> HttpResponse: | ||||
|     assert request.user.is_authenticated | ||||
|  | ||||
|     if realm is not None: | ||||
|         # Same query to get guest user count as in get_seat_count in corporate/lib/stripe.py. | ||||
|         guest_users = UserProfile.objects.filter( | ||||
|             realm=realm, is_active=True, is_bot=False, role=UserProfile.ROLE_GUEST | ||||
|         ).count() | ||||
|         space_used = realm.currently_used_upload_space_bytes() | ||||
|         if title: | ||||
|             pass | ||||
|         else: | ||||
|             title = realm.name or realm.string_id | ||||
|     else: | ||||
|         assert title | ||||
|         guest_users = None | ||||
|         space_used = None | ||||
|  | ||||
|     request_language = get_and_set_request_language( | ||||
|         request, | ||||
|         request.user.default_language, | ||||
|         translation.get_language_from_path(request.path_info), | ||||
|     ) | ||||
|  | ||||
|     # Sync this with stats_params_schema in base_page_params.ts. | ||||
|     page_params = dict( | ||||
|         page_type="stats", | ||||
|         data_url_suffix=data_url_suffix, | ||||
|         upload_space_used=space_used, | ||||
|         guest_users=guest_users, | ||||
|         translation_data=get_language_translation_data(request_language), | ||||
|     ) | ||||
|  | ||||
|     return render( | ||||
|         request, | ||||
|         "analytics/stats.html", | ||||
|         context=dict( | ||||
|             target_name=title, | ||||
|             page_params=page_params, | ||||
|             analytics_ready=analytics_ready, | ||||
|         ), | ||||
|     ) | ||||
|  | ||||
|  | ||||
| @zulip_login_required | ||||
| def stats(request: HttpRequest) -> HttpResponse: | ||||
|     assert request.user.is_authenticated | ||||
|     realm = request.user.realm | ||||
|     if request.user.is_guest: | ||||
|         # TODO: Make @zulip_login_required pass the UserProfile so we | ||||
|         # can use @require_member_or_admin | ||||
|         raise JsonableError(_("Not allowed for guest users")) | ||||
|     return render_stats(request, "", realm, analytics_ready=is_analytics_ready(realm)) | ||||
|  | ||||
|  | ||||
| @require_server_admin | ||||
| @has_request_variables | ||||
| def stats_for_realm(request: HttpRequest, realm_str: str) -> HttpResponse: | ||||
|     try: | ||||
|         realm = get_realm(realm_str) | ||||
|     except Realm.DoesNotExist: | ||||
|         return HttpResponseNotFound() | ||||
|  | ||||
|     return render_stats( | ||||
|         request, | ||||
|         f"/realm/{realm_str}", | ||||
|         realm, | ||||
|         analytics_ready=is_analytics_ready(realm), | ||||
|     ) | ||||
|  | ||||
|  | ||||
| @require_server_admin | ||||
| @has_request_variables | ||||
| def stats_for_remote_realm( | ||||
|     request: HttpRequest, remote_server_id: int, remote_realm_id: int | ||||
| ) -> HttpResponse: | ||||
|     assert settings.ZILENCER_ENABLED | ||||
|     server = RemoteZulipServer.objects.get(id=remote_server_id) | ||||
|     return render_stats( | ||||
|         request, | ||||
|         f"/remote/{server.id}/realm/{remote_realm_id}", | ||||
|         None, | ||||
|         title=f"Realm {remote_realm_id} on server {server.hostname}", | ||||
|     ) | ||||
|  | ||||
|  | ||||
| @require_server_admin_api | ||||
| @has_request_variables | ||||
| def get_chart_data_for_realm( | ||||
|     request: HttpRequest, /, user_profile: UserProfile, realm_str: str, **kwargs: Any | ||||
| ) -> HttpResponse: | ||||
|     try: | ||||
|         realm = get_realm(realm_str) | ||||
|     except Realm.DoesNotExist: | ||||
|         raise JsonableError(_("Invalid organization")) | ||||
|  | ||||
|     return get_chart_data(request, user_profile, realm=realm, **kwargs) | ||||
|  | ||||
|  | ||||
| @require_non_guest_user | ||||
| @has_request_variables | ||||
| def get_chart_data_for_stream( | ||||
|     request: HttpRequest, /, user_profile: UserProfile, stream_id: int | ||||
| ) -> HttpResponse: | ||||
|     stream, ignored_sub = access_stream_by_id( | ||||
|         user_profile, | ||||
|         stream_id, | ||||
|         require_active=True, | ||||
|         allow_realm_admin=True, | ||||
|     ) | ||||
|  | ||||
|     return get_chart_data(request, user_profile, stream=stream) | ||||
|  | ||||
|  | ||||
| @require_server_admin_api | ||||
| @has_request_variables | ||||
| def get_chart_data_for_remote_realm( | ||||
|     request: HttpRequest, | ||||
|     /, | ||||
|     user_profile: UserProfile, | ||||
|     remote_server_id: int, | ||||
|     remote_realm_id: int, | ||||
|     **kwargs: Any, | ||||
| ) -> HttpResponse: | ||||
|     assert settings.ZILENCER_ENABLED | ||||
|     server = RemoteZulipServer.objects.get(id=remote_server_id) | ||||
|     return get_chart_data( | ||||
|         request, | ||||
|         user_profile, | ||||
|         server=server, | ||||
|         remote=True, | ||||
|         remote_realm_id=int(remote_realm_id), | ||||
|         **kwargs, | ||||
|     ) | ||||
|  | ||||
|  | ||||
| @require_server_admin | ||||
| def stats_for_installation(request: HttpRequest) -> HttpResponse: | ||||
|     assert request.user.is_authenticated | ||||
|     return render_stats(request, "/installation", None, title="installation") | ||||
|  | ||||
|  | ||||
| @require_server_admin | ||||
| def stats_for_remote_installation(request: HttpRequest, remote_server_id: int) -> HttpResponse: | ||||
|     assert settings.ZILENCER_ENABLED | ||||
|     server = RemoteZulipServer.objects.get(id=remote_server_id) | ||||
|     return render_stats( | ||||
|         request, | ||||
|         f"/remote/{server.id}/installation", | ||||
|         None, | ||||
|         title=f"remote installation {server.hostname}", | ||||
|     ) | ||||
|  | ||||
|  | ||||
| @require_server_admin_api | ||||
| @has_request_variables | ||||
| def get_chart_data_for_installation( | ||||
|     request: HttpRequest, /, user_profile: UserProfile, chart_name: str = REQ(), **kwargs: Any | ||||
| ) -> HttpResponse: | ||||
|     return get_chart_data(request, user_profile, for_installation=True, **kwargs) | ||||
|  | ||||
|  | ||||
| @require_server_admin_api | ||||
| @has_request_variables | ||||
| def get_chart_data_for_remote_installation( | ||||
|     request: HttpRequest, | ||||
|     /, | ||||
|     user_profile: UserProfile, | ||||
|     remote_server_id: int, | ||||
|     chart_name: str = REQ(), | ||||
|     **kwargs: Any, | ||||
| ) -> HttpResponse: | ||||
|     assert settings.ZILENCER_ENABLED | ||||
|     server = RemoteZulipServer.objects.get(id=remote_server_id) | ||||
|     return get_chart_data( | ||||
|         request, | ||||
|         user_profile, | ||||
|         for_installation=True, | ||||
|         remote=True, | ||||
|         server=server, | ||||
|         **kwargs, | ||||
|     ) | ||||
|  | ||||
|  | ||||
| @require_non_guest_user | ||||
| @has_request_variables | ||||
| def get_chart_data( | ||||
|     request: HttpRequest, | ||||
|     user_profile: UserProfile, | ||||
|     chart_name: str = REQ(), | ||||
|     min_length: int | None = REQ(converter=to_non_negative_int, default=None), | ||||
|     start: datetime | None = REQ(converter=to_utc_datetime, default=None), | ||||
|     end: datetime | None = REQ(converter=to_utc_datetime, default=None), | ||||
|     # These last several parameters are only used by functions | ||||
|     # wrapping get_chart_data; the callers are responsible for | ||||
|     # parsing/validation/authorization for them. | ||||
|     realm: Realm | None = None, | ||||
|     for_installation: bool = False, | ||||
|     remote: bool = False, | ||||
|     remote_realm_id: int | None = None, | ||||
|     server: Optional["RemoteZulipServer"] = None, | ||||
|     stream: Stream | None = None, | ||||
| ) -> HttpResponse: | ||||
|     TableType: TypeAlias = ( | ||||
|         type["RemoteInstallationCount"] | ||||
|         | type[InstallationCount] | ||||
|         | type["RemoteRealmCount"] | ||||
|         | type[RealmCount] | ||||
|     ) | ||||
|     if for_installation: | ||||
|         if remote: | ||||
|             assert settings.ZILENCER_ENABLED | ||||
|             aggregate_table: TableType = RemoteInstallationCount | ||||
|             assert server is not None | ||||
|         else: | ||||
|             aggregate_table = InstallationCount | ||||
|     else: | ||||
|         if remote: | ||||
|             assert settings.ZILENCER_ENABLED | ||||
|             aggregate_table = RemoteRealmCount | ||||
|             assert server is not None | ||||
|             assert remote_realm_id is not None | ||||
|         else: | ||||
|             aggregate_table = RealmCount | ||||
|  | ||||
|     tables: ( | ||||
|         tuple[TableType] | tuple[TableType, type[UserCount]] | tuple[TableType, type[StreamCount]] | ||||
|     ) | ||||
|  | ||||
|     if chart_name == "number_of_humans": | ||||
|         stats = [ | ||||
|             COUNT_STATS["1day_actives::day"], | ||||
|             COUNT_STATS["realm_active_humans::day"], | ||||
|             COUNT_STATS["active_users_audit:is_bot:day"], | ||||
|         ] | ||||
|         tables = (aggregate_table,) | ||||
|         subgroup_to_label: dict[CountStat, dict[str | None, str]] = { | ||||
|             stats[0]: {None: "_1day"}, | ||||
|             stats[1]: {None: "_15day"}, | ||||
|             stats[2]: {"false": "all_time"}, | ||||
|         } | ||||
|         labels_sort_function = None | ||||
|         include_empty_subgroups = True | ||||
|     elif chart_name == "messages_sent_over_time": | ||||
|         stats = [COUNT_STATS["messages_sent:is_bot:hour"]] | ||||
|         tables = (aggregate_table, UserCount) | ||||
|         subgroup_to_label = {stats[0]: {"false": "human", "true": "bot"}} | ||||
|         labels_sort_function = None | ||||
|         include_empty_subgroups = True | ||||
|     elif chart_name == "messages_sent_by_message_type": | ||||
|         stats = [COUNT_STATS["messages_sent:message_type:day"]] | ||||
|         tables = (aggregate_table, UserCount) | ||||
|         subgroup_to_label = { | ||||
|             stats[0]: { | ||||
|                 "public_stream": _("Public channels"), | ||||
|                 "private_stream": _("Private channels"), | ||||
|                 "private_message": _("Direct messages"), | ||||
|                 "huddle_message": _("Group direct messages"), | ||||
|             } | ||||
|         } | ||||
|         labels_sort_function = lambda data: sort_by_totals(data["everyone"]) | ||||
|         include_empty_subgroups = True | ||||
|     elif chart_name == "messages_sent_by_client": | ||||
|         stats = [COUNT_STATS["messages_sent:client:day"]] | ||||
|         tables = (aggregate_table, UserCount) | ||||
|         # Note that the labels are further re-written by client_label_map | ||||
|         subgroup_to_label = { | ||||
|             stats[0]: {str(id): name for id, name in Client.objects.values_list("id", "name")} | ||||
|         } | ||||
|         labels_sort_function = sort_client_labels | ||||
|         include_empty_subgroups = False | ||||
|     elif chart_name == "messages_read_over_time": | ||||
|         stats = [COUNT_STATS["messages_read::hour"]] | ||||
|         tables = (aggregate_table, UserCount) | ||||
|         subgroup_to_label = {stats[0]: {None: "read"}} | ||||
|         labels_sort_function = None | ||||
|         include_empty_subgroups = True | ||||
|     elif chart_name == "messages_sent_by_stream": | ||||
|         if stream is None: | ||||
|             raise JsonableError( | ||||
|                 _("Missing channel for chart: {chart_name}").format(chart_name=chart_name) | ||||
|             ) | ||||
|         stats = [COUNT_STATS["messages_in_stream:is_bot:day"]] | ||||
|         tables = (aggregate_table, StreamCount) | ||||
|         subgroup_to_label = {stats[0]: {"false": "human", "true": "bot"}} | ||||
|         labels_sort_function = None | ||||
|         include_empty_subgroups = True | ||||
|     else: | ||||
|         raise JsonableError(_("Unknown chart name: {chart_name}").format(chart_name=chart_name)) | ||||
|  | ||||
|     # Most likely someone using our API endpoint. The /stats page does not | ||||
|     # pass a start or end in its requests. | ||||
|     if start is not None: | ||||
|         start = convert_to_UTC(start) | ||||
|     if end is not None: | ||||
|         end = convert_to_UTC(end) | ||||
|     if start is not None and end is not None and start > end: | ||||
|         raise JsonableError( | ||||
|             _("Start time is later than end time. Start: {start}, End: {end}").format( | ||||
|                 start=start, | ||||
|                 end=end, | ||||
|             ) | ||||
|         ) | ||||
|  | ||||
|     if realm is None: | ||||
|         # Note that this value is invalid for Remote tables; be | ||||
|         # careful not to access it in those code paths. | ||||
|         realm = user_profile.realm | ||||
|  | ||||
|     if remote: | ||||
|         # For remote servers, we don't have fillstate data, and thus | ||||
|         # should simply use the first and last data points for the | ||||
|         # table. | ||||
|         assert server is not None | ||||
|         assert aggregate_table is RemoteInstallationCount or aggregate_table is RemoteRealmCount | ||||
|         aggregate_table_remote = cast( | ||||
|             type[RemoteInstallationCount] | type[RemoteRealmCount], aggregate_table | ||||
|         )  # https://stackoverflow.com/questions/68540528/mypy-assertions-on-the-types-of-types | ||||
|         if not aggregate_table_remote.objects.filter(server=server).exists(): | ||||
|             raise JsonableError( | ||||
|                 _("No analytics data available. Please contact your server administrator.") | ||||
|             ) | ||||
|         if start is None: | ||||
|             first = ( | ||||
|                 aggregate_table_remote.objects.filter(server=server).order_by("remote_id").first() | ||||
|             ) | ||||
|             assert first is not None | ||||
|             start = first.end_time | ||||
|         if end is None: | ||||
|             last = aggregate_table_remote.objects.filter(server=server).order_by("remote_id").last() | ||||
|             assert last is not None | ||||
|             end = last.end_time | ||||
|     else: | ||||
|         # Otherwise, we can use tables on the current server to | ||||
|         # determine a nice range, and some additional validation. | ||||
|         if start is None: | ||||
|             if for_installation: | ||||
|                 start = installation_epoch() | ||||
|             else: | ||||
|                 start = realm.date_created | ||||
|         if end is None: | ||||
|             end = max( | ||||
|                 stat.last_successful_fill() or datetime.min.replace(tzinfo=timezone.utc) | ||||
|                 for stat in stats | ||||
|             ) | ||||
|  | ||||
|         if start > end and (timezone_now() - start > MAX_TIME_FOR_FULL_ANALYTICS_GENERATION): | ||||
|             logging.warning( | ||||
|                 "User from realm %s attempted to access /stats, but the computed " | ||||
|                 "start time: %s (creation of realm or installation) is later than the computed " | ||||
|                 "end time: %s (last successful analytics update). Is the " | ||||
|                 "analytics cron job running?", | ||||
|                 realm.string_id, | ||||
|                 start, | ||||
|                 end, | ||||
|             ) | ||||
|             raise JsonableError( | ||||
|                 _("No analytics data available. Please contact your server administrator.") | ||||
|             ) | ||||
|  | ||||
|     assert len({stat.frequency for stat in stats}) == 1 | ||||
|     end_times = time_range(start, end, stats[0].frequency, min_length) | ||||
|     data: dict[str, Any] = { | ||||
|         "end_times": [int(end_time.timestamp()) for end_time in end_times], | ||||
|         "frequency": stats[0].frequency, | ||||
|     } | ||||
|  | ||||
|     aggregation_level = { | ||||
|         InstallationCount: "everyone", | ||||
|         RealmCount: "everyone", | ||||
|         UserCount: "user", | ||||
|         StreamCount: "everyone", | ||||
|     } | ||||
|     if settings.ZILENCER_ENABLED: | ||||
|         aggregation_level[RemoteInstallationCount] = "everyone" | ||||
|         aggregation_level[RemoteRealmCount] = "everyone" | ||||
|  | ||||
|     # -1 is a placeholder value, since there is no relevant filtering on InstallationCount | ||||
|     id_value = { | ||||
|         InstallationCount: -1, | ||||
|         RealmCount: realm.id, | ||||
|         UserCount: user_profile.id, | ||||
|     } | ||||
|     if stream is not None: | ||||
|         id_value[StreamCount] = stream.id | ||||
|  | ||||
|     if settings.ZILENCER_ENABLED: | ||||
|         if server is not None: | ||||
|             id_value[RemoteInstallationCount] = server.id | ||||
|         # TODO: RemoteRealmCount logic doesn't correctly handle | ||||
|         # filtering by server_id as well. | ||||
|         if remote_realm_id is not None: | ||||
|             id_value[RemoteRealmCount] = remote_realm_id | ||||
|  | ||||
|     for table in tables: | ||||
|         data[aggregation_level[table]] = {} | ||||
|         for stat in stats: | ||||
|             data[aggregation_level[table]].update( | ||||
|                 get_time_series_by_subgroup( | ||||
|                     stat, | ||||
|                     table, | ||||
|                     id_value[table], | ||||
|                     end_times, | ||||
|                     subgroup_to_label[stat], | ||||
|                     include_empty_subgroups, | ||||
|                 ) | ||||
|             ) | ||||
|  | ||||
|     if labels_sort_function is not None: | ||||
|         data["display_order"] = labels_sort_function(data) | ||||
|     else: | ||||
|         data["display_order"] = None | ||||
|     return json_success(request, data=data) | ||||
|  | ||||
|  | ||||
| def sort_by_totals(value_arrays: dict[str, list[int]]) -> list[str]: | ||||
|     totals = sorted(((sum(values), label) for label, values in value_arrays.items()), reverse=True) | ||||
|     return [label for total, label in totals] | ||||
|  | ||||
|  | ||||
| # For any given user, we want to show a fixed set of clients in the chart, | ||||
| # regardless of the time aggregation or whether we're looking at realm or | ||||
| # user data. This fixed set ideally includes the clients most important in | ||||
| # understanding the realm's traffic and the user's traffic. This function | ||||
| # tries to rank the clients so that taking the first N elements of the | ||||
| # sorted list has a reasonable chance of doing so. | ||||
| def sort_client_labels(data: dict[str, dict[str, list[int]]]) -> list[str]: | ||||
|     realm_order = sort_by_totals(data["everyone"]) | ||||
|     user_order = sort_by_totals(data["user"]) | ||||
|     label_sort_values: dict[str, float] = {label: i for i, label in enumerate(realm_order)} | ||||
|     for i, label in enumerate(user_order): | ||||
|         label_sort_values[label] = min(i - 0.1, label_sort_values.get(label, i)) | ||||
|     return [label for label, sort_value in sorted(label_sort_values.items(), key=lambda x: x[1])] | ||||
|  | ||||
|  | ||||
| CountT = TypeVar("CountT", bound=BaseCount) | ||||
|  | ||||
|  | ||||
| def table_filtered_to_id(table: type[CountT], key_id: int) -> QuerySet[CountT]: | ||||
|     if table == RealmCount: | ||||
|         return table._default_manager.filter(realm_id=key_id) | ||||
|     elif table == UserCount: | ||||
|         return table._default_manager.filter(user_id=key_id) | ||||
|     elif table == StreamCount: | ||||
|         return table._default_manager.filter(stream_id=key_id) | ||||
|     elif table == InstallationCount: | ||||
|         return table._default_manager.all() | ||||
|     elif settings.ZILENCER_ENABLED and table == RemoteInstallationCount: | ||||
|         return table._default_manager.filter(server_id=key_id) | ||||
|     elif settings.ZILENCER_ENABLED and table == RemoteRealmCount: | ||||
|         return table._default_manager.filter(realm_id=key_id) | ||||
|     else: | ||||
|         raise AssertionError(f"Unknown table: {table}") | ||||
|  | ||||
|  | ||||
| def client_label_map(name: str) -> str: | ||||
|     if name == "website": | ||||
|         return "Web app" | ||||
|     if name.startswith("desktop app"): | ||||
|         return "Old desktop app" | ||||
|     if name == "ZulipElectron": | ||||
|         return "Desktop app" | ||||
|     if name == "ZulipTerminal": | ||||
|         return "Terminal app" | ||||
|     if name == "ZulipAndroid": | ||||
|         return "Old Android app" | ||||
|     if name == "ZulipiOS": | ||||
|         return "Old iOS app" | ||||
|     if name == "ZulipMobile": | ||||
|         return "Mobile app (React Native)" | ||||
|     if name in ["ZulipFlutter", "ZulipMobile/flutter"]: | ||||
|         return "Mobile app beta (Flutter)" | ||||
|     if name in ["ZulipPython", "API: Python"]: | ||||
|         return "Python API" | ||||
|     if name.startswith("Zulip") and name.endswith("Webhook"): | ||||
|         return name[len("Zulip") : -len("Webhook")] + " webhook" | ||||
|     return name | ||||
|  | ||||
|  | ||||
| def rewrite_client_arrays(value_arrays: dict[str, list[int]]) -> dict[str, list[int]]: | ||||
|     mapped_arrays: dict[str, list[int]] = {} | ||||
|     for label, array in value_arrays.items(): | ||||
|         mapped_label = client_label_map(label) | ||||
|         if mapped_label in mapped_arrays: | ||||
|             for i in range(len(array)): | ||||
|                 mapped_arrays[mapped_label][i] += value_arrays[label][i] | ||||
|         else: | ||||
|             mapped_arrays[mapped_label] = [value_arrays[label][i] for i in range(len(array))] | ||||
|     return mapped_arrays | ||||
|  | ||||
|  | ||||
| def get_time_series_by_subgroup( | ||||
|     stat: CountStat, | ||||
|     table: type[BaseCount], | ||||
|     key_id: int, | ||||
|     end_times: list[datetime], | ||||
|     subgroup_to_label: dict[str | None, str], | ||||
|     include_empty_subgroups: bool, | ||||
| ) -> dict[str, list[int]]: | ||||
|     queryset = ( | ||||
|         table_filtered_to_id(table, key_id) | ||||
|         .filter(property=stat.property) | ||||
|         .values_list("subgroup", "end_time", "value") | ||||
|     ) | ||||
|     value_dicts: dict[str | None, dict[datetime, int]] = defaultdict(lambda: defaultdict(int)) | ||||
|     for subgroup, end_time, value in queryset: | ||||
|         value_dicts[subgroup][end_time] = value | ||||
|     value_arrays = {} | ||||
|     for subgroup, label in subgroup_to_label.items(): | ||||
|         if (subgroup in value_dicts) or include_empty_subgroups: | ||||
|             value_arrays[label] = [value_dicts[subgroup][end_time] for end_time in end_times] | ||||
|  | ||||
|     if stat == COUNT_STATS["messages_sent:client:day"]: | ||||
|         # HACK: We rewrite these arrays to collapse the Client objects | ||||
|         # with similar names into a single sum, and generally give | ||||
|         # them better names | ||||
|         return rewrite_client_arrays(value_arrays) | ||||
|     return value_arrays | ||||
| @@ -1,31 +0,0 @@ | ||||
| {generate_api_header(API_ENDPOINT_NAME)} | ||||
|  | ||||
| ## Usage examples | ||||
|  | ||||
| {start_tabs} | ||||
|  | ||||
| {generate_code_example(python)|API_ENDPOINT_NAME|example} | ||||
|  | ||||
| {generate_code_example(javascript)|API_ENDPOINT_NAME|example} | ||||
|  | ||||
| {tab|curl} | ||||
|  | ||||
| {generate_code_example(curl)|API_ENDPOINT_NAME|example} | ||||
|  | ||||
| {end_tabs} | ||||
|  | ||||
| ## Parameters | ||||
|  | ||||
| {generate_api_arguments_table|zulip.yaml|API_ENDPOINT_NAME} | ||||
|  | ||||
| {generate_parameter_description(API_ENDPOINT_NAME)} | ||||
|  | ||||
| ## Response | ||||
|  | ||||
| {generate_return_values_table|zulip.yaml|API_ENDPOINT_NAME} | ||||
|  | ||||
| {generate_response_description(API_ENDPOINT_NAME)} | ||||
|  | ||||
| #### Example response(s) | ||||
|  | ||||
| {generate_code_example|API_ENDPOINT_NAME|fixture} | ||||
| @@ -1,89 +0,0 @@ | ||||
| # API keys | ||||
|  | ||||
| An **API key** is how a bot identifies itself to Zulip. For the official | ||||
| clients, such as the Python bindings, we recommend [downloading a `zuliprc` | ||||
| file](/api/configuring-python-bindings#download-a-zuliprc-file). This file | ||||
| contains an API key and other necessary configuration values for using the | ||||
| Zulip API with a specific account on a Zulip server. | ||||
|  | ||||
| ## Get a bot's API key | ||||
|  | ||||
| {start_tabs} | ||||
|  | ||||
| {tab|desktop-web} | ||||
|  | ||||
| {settings_tab|your-bots} | ||||
|  | ||||
| 1. Click **Active bots**. | ||||
|  | ||||
| 1. Find your bot. The bot's API key is under **API KEY**. | ||||
|  | ||||
| {end_tabs} | ||||
|  | ||||
| !!! warn "" | ||||
|  | ||||
|     Anyone with a bot's API key can impersonate the bot, so be careful with it! | ||||
|  | ||||
| ## Get your API key | ||||
|  | ||||
| {start_tabs} | ||||
|  | ||||
| {tab|desktop-web} | ||||
|  | ||||
| {settings_tab|account-and-privacy} | ||||
|  | ||||
| 1. Under **API key**, click **Manage your API key**. | ||||
|  | ||||
| 1. Enter your password, and click **Get API key**. If you don't know your | ||||
|    password, click **reset it** and follow the instructions from there. | ||||
|  | ||||
| 1. Copy your API key. | ||||
|  | ||||
| {end_tabs} | ||||
|  | ||||
| !!! warn "" | ||||
|  | ||||
|     Anyone with your API key can impersonate you, so be doubly careful with it. | ||||
|  | ||||
|  | ||||
| ## Invalidate an API key | ||||
|  | ||||
| To invalidate an existing API key, you have to generate a new key. | ||||
|  | ||||
| ### Invalidate a bot's API key | ||||
|  | ||||
| {start_tabs} | ||||
|  | ||||
| {tab|desktop-web} | ||||
|  | ||||
| {settings_tab|your-bots} | ||||
|  | ||||
| 1. Click **Active bots**. | ||||
|  | ||||
| 1. Find your bot. | ||||
|  | ||||
| 1. Under **API KEY**, click the **refresh** (<i class="fa fa-refresh"></i>) icon | ||||
|    to the right of the bot's API key. | ||||
|  | ||||
| {end_tabs} | ||||
|  | ||||
| ### Invalidate your API key | ||||
|  | ||||
| {start_tabs} | ||||
|  | ||||
| {tab|desktop-web} | ||||
|  | ||||
| {settings_tab|account-and-privacy} | ||||
|  | ||||
| 1. Under **API key**, click **Manage your API key**. | ||||
|  | ||||
| 1. Enter your password, and click **Get API key**. If you don't know your | ||||
|    password, click **reset it** and follow the instructions from there. | ||||
|  | ||||
| 1. Click **Generate new API key** | ||||
|  | ||||
| {end_tabs} | ||||
|  | ||||
| ## Related articles | ||||
|  | ||||
| * [Configuring the Python bindings](/api/configuring-python-bindings) | ||||
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							| @@ -1,161 +0,0 @@ | ||||
| # Configuring the Python bindings | ||||
|  | ||||
| Zulip provides a set of tools that allows interacting with its API more | ||||
| easily, called the [Python bindings](https://pypi.python.org/pypi/zulip/). | ||||
| One of the most notable use cases for these bindings are bots developed | ||||
| using Zulip's [bot framework](/api/writing-bots). | ||||
|  | ||||
| In order to use them, you need to configure them with your identity | ||||
| (account, API key, and Zulip server URL). There are a few ways to | ||||
| achieve that: | ||||
|  | ||||
| - Using a `zuliprc` file, referenced via the `--config-file` option or | ||||
|   the `config_file` option to the `zulip.Client` constructor | ||||
|   (recommended for bots). | ||||
| - Using a `zuliprc` file in your home directory at `~/.zuliprc` | ||||
|   (recommended for your own API key). | ||||
| - Using the [environment | ||||
|   variables](https://en.wikipedia.org/wiki/Environment_variable) | ||||
|   documented below. | ||||
| - Using the `--api-key`, `--email`, and `--site` variables as command | ||||
|   line parameters. | ||||
| - Using the `api_key`, `email`, and `site` parameters to the | ||||
|   `zulip.Client` constructor. | ||||
|  | ||||
| ## Download a `zuliprc` file | ||||
|  | ||||
| {start_tabs} | ||||
|  | ||||
| {tab|for-a-bot} | ||||
|  | ||||
| {settings_tab|your-bots} | ||||
|  | ||||
| 1. Click the **download** (<i class="fa fa-download"></i>) icon on the profile | ||||
|    card of the desired bot to download the bot's `zuliprc` file. | ||||
|  | ||||
| !!! warn "" | ||||
|  | ||||
|     Anyone with a bot's API key can impersonate the bot, so be careful with it! | ||||
|  | ||||
| {tab|for-yourself} | ||||
|  | ||||
| {settings_tab|account-and-privacy} | ||||
|  | ||||
| 1. Under **API key**, click **Manage your API key**. | ||||
|  | ||||
| 1. Enter your password, and click **Get API key**. If you don't know your | ||||
|    password, click **reset it** and follow the | ||||
|    instructions from there. | ||||
|  | ||||
| 1. Click **Download zuliprc** to download your `zuliprc` file. | ||||
|  | ||||
| 1. (optional) If you'd like your credentials to be used by default | ||||
|    when using the Zulip API on your computer, move the `zuliprc` file | ||||
|    to `~/.zuliprc` in your home directory. | ||||
|  | ||||
| !!! warn "" | ||||
|  | ||||
|     Anyone with your API key can impersonate you, so be doubly careful with it. | ||||
|  | ||||
| {end_tabs} | ||||
|  | ||||
| ## Configuration keys and environment variables | ||||
|  | ||||
| `zuliprc` is a configuration file written in the | ||||
| [INI file format](https://en.wikipedia.org/wiki/INI_file), | ||||
| which contains key-value pairs as shown in the following example: | ||||
|  | ||||
| ``` | ||||
| [api] | ||||
| key=<API key from the web interface> | ||||
| email=<your email address> | ||||
| site=<your Zulip server's URI> | ||||
| ... | ||||
| ``` | ||||
|  | ||||
| The keys you can use in this file (and their equivalent environment variables) | ||||
| can be found in the following table: | ||||
|  | ||||
| <table class="table"> | ||||
|     <thead> | ||||
|         <tr> | ||||
|             <th><code>zuliprc</code> key</th> | ||||
|             <th>Environment variable</th> | ||||
|             <th>Required</th> | ||||
|             <th>Description</th> | ||||
|         </tr> | ||||
|     </thead> | ||||
|     <tr> | ||||
|         <td><code>key</code></td> | ||||
|         <td><code>ZULIP_API_KEY</code></td> | ||||
|         <td>Yes</td> | ||||
|         <td> | ||||
|             <a href="/api/api-keys">API key</a>, which you can get through | ||||
|             Zulip's web interface. | ||||
|         </td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|         <td><code>email</code></td> | ||||
|         <td><code>ZULIP_EMAIL</code></td> | ||||
|         <td>Yes</td> | ||||
|         <td> | ||||
|             The email address of the user who owns the API key mentioned | ||||
|             above. | ||||
|         </td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|         <td><code>site</code></td> | ||||
|         <td><code>ZULIP_SITE</code></td> | ||||
|         <td>No</td> | ||||
|         <td> | ||||
|             URL where your Zulip server is located. | ||||
|         </td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|         <td><code>client_cert_key</code></td> | ||||
|         <td><code>ZULIP_CERT_KEY</code></td> | ||||
|         <td>No</td> | ||||
|         <td> | ||||
|             Path to the SSL/TLS private key that the binding should use to | ||||
|             connect to the server. | ||||
|         </td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|         <td><code>client_cert</code></td> | ||||
|         <td><code>ZULIP_CERT</code></td> | ||||
|         <td>No*</td> | ||||
|         <td> | ||||
|             The public counterpart of <code>client_cert_key</code>/ | ||||
|             <code>ZULIP_CERT_KEY</code>. <i>This setting is required if a cert | ||||
|             key has been set.</i> | ||||
|         </td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|         <td><code>client_bundle</code></td> | ||||
|         <td><code>ZULIP_CERT_BUNDLE</code></td> | ||||
|         <td>No</td> | ||||
|         <td> | ||||
|             Path where the server's PEM-encoded certificate is located. CA | ||||
|             certificates are also accepted, in case those CA's have issued the | ||||
|             server's certificate. Defaults to the built-in CA bundle trusted | ||||
|             by Python. | ||||
|         </td> | ||||
|     </tr> | ||||
|     <tr> | ||||
|         <td><code>insecure</code></td> | ||||
|         <td><code>ZULIP_ALLOW_INSECURE</code></td> | ||||
|         <td>No</td> | ||||
|         <td> | ||||
|             Allows connecting to Zulip servers with an invalid SSL/TLS | ||||
|             certificate. Please note that enabling this will make the HTTPS | ||||
|             connection insecure. Defaults to <code>false</code>. | ||||
|         </td> | ||||
|     </tr> | ||||
| </table> | ||||
|  | ||||
| ## Related articles | ||||
|  | ||||
| * [Installation instructions](/api/installation-instructions) | ||||
| * [API keys](/api/api-keys) | ||||
| * [Running bots](/api/running-bots) | ||||
| * [Deploying bots](/api/deploying-bots) | ||||
| @@ -1,173 +0,0 @@ | ||||
| # Construct a narrow | ||||
|  | ||||
| A **narrow** is a set of filters for Zulip messages, that can be based | ||||
| on many different factors (like sender, channel, topic, search | ||||
| keywords, etc.). Narrows are used in various places in the Zulip | ||||
| API (most importantly, in the API for fetching messages). | ||||
|  | ||||
| It is simplest to explain the algorithm for encoding a search as a | ||||
| narrow using a single example. Consider the following search query | ||||
| (written as it would be entered in the Zulip web app's search box). | ||||
| It filters for messages sent to channel `announce`, not sent by | ||||
| `iago@zulip.com`, and containing the words `cool` and `sunglasses`: | ||||
|  | ||||
| ``` | ||||
| channel:announce -sender:iago@zulip.com cool sunglasses | ||||
| ``` | ||||
|  | ||||
| This query would be JSON-encoded for use in the Zulip API using JSON | ||||
| as a list of simple objects, as follows: | ||||
|  | ||||
| ```json | ||||
| [ | ||||
|     { | ||||
|         "operator": "channel", | ||||
|         "operand": "announce" | ||||
|     }, | ||||
|     { | ||||
|         "operator": "sender", | ||||
|         "operand": "iago@zulip.com", | ||||
|         "negated": true | ||||
|     }, | ||||
|     { | ||||
|         "operator": "search", | ||||
|         "operand": "cool sunglasses" | ||||
|     } | ||||
| ] | ||||
| ``` | ||||
|  | ||||
| The Zulip help center article on [searching for messages](/help/search-for-messages) | ||||
| documents the majority of the search/narrow options supported by the | ||||
| Zulip API. | ||||
|  | ||||
| Note that many narrows, including all that lack a `channel` or `channels` | ||||
| operator, search the current user's personal message history. See | ||||
| [searching shared history](/help/search-for-messages#searching-shared-history) | ||||
| for details. | ||||
|  | ||||
| Clients should note that the `is:unread` filter takes advantage of the | ||||
| fact that there is a database index for unread messages, which can be an | ||||
| important optimization when fetching messages in certain cases (e.g., | ||||
| when [adding the `read` flag to a user's personal | ||||
| messages](/api/update-message-flags-for-narrow)). | ||||
|  | ||||
| ## Changes | ||||
|  | ||||
| * In Zulip 9.0 (feature level 271), support was added for a new filter | ||||
|   operator, `with`, which uses a [message ID](#message-ids) for its | ||||
|   operand, and is designed for creating permanent links to topics. | ||||
|  | ||||
| * In Zulip 9.0 (feature level 265), support was added for a new | ||||
|   `is:followed` filter, matching messages in topics that the current | ||||
|   user is [following](/help/follow-a-topic). | ||||
|  | ||||
| * In Zulip 9.0 (feature level 250), support was added for two filters | ||||
|   related to stream messages: `channel` and `channels`. The `channel` | ||||
|   operator is an alias for the `stream` operator. The `channels` | ||||
|   operator is an alias for the `streams` operator. Both `channel` and | ||||
|   `channels` return the same exact results as `stream` and `streams` | ||||
|   respectively. | ||||
|  | ||||
| * In Zulip 9.0 (feature level 249), support was added for a new filter, | ||||
|   `has:reaction`, which returns messages that have at least one [emoji | ||||
|   reaction](/help/emoji-reactions). | ||||
|  | ||||
| * In Zulip 7.0 (feature level 177), support was added for three filters | ||||
|   related to direct messages: `is:dm`, `dm` and `dm-including`. The | ||||
|   `dm` operator replaced and deprecated the `pm-with` operator. The | ||||
|   `is:dm` filter replaced and deprecated the `is:private` filter. The | ||||
|   `dm-including` operator replaced and deprecated the `group-pm-with` | ||||
|   operator. | ||||
|  | ||||
|     * The `dm-including` and `group-pm-with` operators return slightly | ||||
|       different results. For example, `dm-including:1234` returns all | ||||
|       direct messages (1-on-1 and group) that include the current user | ||||
|       and the user with the unique user ID of `1234`. On the other hand, | ||||
|       `group-pm-with:1234` returned only group direct messages that | ||||
|       included the current user and the user with the unique user ID of | ||||
|       `1234`. | ||||
|  | ||||
|     * Both `dm` and `is:dm` are aliases of `pm-with` and `is:private` | ||||
|       respectively, and return the same exact results that the | ||||
|       deprecated filters did. | ||||
|  | ||||
| ## Narrows that use IDs | ||||
|  | ||||
| ### Message IDs | ||||
|  | ||||
| The `near`, `id` and `with` operators use message IDs for their | ||||
| operands. The `near` and `id` operators are documented in the help | ||||
| center [here](/help/search-for-messages#search-by-message-id). | ||||
|  | ||||
| The `with` operator is designed to be used for permanent links to topics, | ||||
| which means they should continue to work when the topic is | ||||
| [moved](/help/move-content-to-another-topic) or | ||||
| [resolved](/help/resolve-a-topic). If the message with the specified ID | ||||
| exists, and can be accessed by the user, then it will return messages | ||||
| with the `channel`/`topic`/`dm` operators corresponding to the current | ||||
| conversation containing that message, and replacing any such filters | ||||
| included in the narrow. | ||||
|  | ||||
| * `with:12345`: Search for the conversation that contains the message | ||||
|   with ID `12345`. | ||||
| * `near:12345`: Search messages around the message with ID `12345`. | ||||
| * `id:12345`: Search for only the message with ID `12345`. | ||||
|  | ||||
| The message ID operand for the `with` and `id` operators may be encoded | ||||
| as either a number or a string. The message ID operand for the `near` | ||||
| operator must be encoded as a string. | ||||
|  | ||||
| **Changes**: Prior to Zulip 8.0 (feature level 194), the message ID | ||||
| operand for the `id` operator needed to be encoded as a string. | ||||
|  | ||||
|  | ||||
| ```json | ||||
| [ | ||||
|     { | ||||
|         "operator": "id", | ||||
|         "operand": 12345 | ||||
|     } | ||||
| ] | ||||
| ``` | ||||
|  | ||||
| ### Channel and user IDs | ||||
|  | ||||
| There are a few additional narrow/search options (new in Zulip 2.1) | ||||
| that use either channel IDs or user IDs that are not documented in the | ||||
| help center because they are primarily useful to API clients: | ||||
|  | ||||
| * `channel:1234`: Search messages sent to the channel with ID `1234`. | ||||
| * `sender:1234`: Search messages sent by user ID `1234`. | ||||
| * `dm:1234`: Search the direct message conversation between | ||||
|   you and user ID `1234`. | ||||
| * `dm:1234,5678`: Search the direct message conversation between | ||||
|   you, user ID `1234`, and user ID `5678`. | ||||
| * `dm-including:1234`: Search all direct messages (1-on-1 and group) | ||||
|   that include you and user ID `1234`. | ||||
|  | ||||
| !!! tip "" | ||||
|  | ||||
|     A user ID can be found by [viewing a user's profile][view-profile] | ||||
|     in the web or desktop apps. A channel ID can be found when [browsing | ||||
|     channels][browse-channels] in the web or desktop apps. | ||||
|  | ||||
| The operands for these search options must be encoded either as an | ||||
| integer ID or a JSON list of integer IDs. For example, to query | ||||
| messages sent by a user 1234 to a direct message thread with yourself, | ||||
| user 1234, and user 5678, the correct JSON-encoded query is: | ||||
|  | ||||
| ```json | ||||
| [ | ||||
|     { | ||||
|         "operator": "dm", | ||||
|         "operand": [1234, 5678] | ||||
|     }, | ||||
|     { | ||||
|         "operator": "sender", | ||||
|         "operand": 1234 | ||||
|     } | ||||
| ] | ||||
| ``` | ||||
|  | ||||
| [view-profile]: /help/view-someones-profile | ||||
| [browse-channels]: /help/introduction-to-channels#browse-and-subscribe-to-channels | ||||
| @@ -1,49 +0,0 @@ | ||||
| {generate_api_header(/scheduled_messages:post)} | ||||
|  | ||||
| ## Usage examples | ||||
|  | ||||
| {start_tabs} | ||||
|  | ||||
| {generate_code_example(python)|/scheduled_messages:post|example} | ||||
|  | ||||
| {generate_code_example(javascript)|/scheduled_messages:post|example} | ||||
|  | ||||
| {tab|curl} | ||||
|  | ||||
| ``` curl | ||||
| # Create a scheduled channel message | ||||
| curl -X POST {{ api_url }}/v1/scheduled_messages \ | ||||
|     -u BOT_EMAIL_ADDRESS:BOT_API_KEY \ | ||||
|     --data-urlencode type=stream \ | ||||
|     --data-urlencode to=9 \ | ||||
|     --data-urlencode topic=Hello \ | ||||
|     --data-urlencode 'content=Nice to meet everyone!' \ | ||||
|     --data-urlencode scheduled_delivery_timestamp=3165826990 | ||||
|  | ||||
| # Create a scheduled direct message | ||||
| curl -X POST {{ api_url }}/v1/messages \ | ||||
|     -u BOT_EMAIL_ADDRESS:BOT_API_KEY \ | ||||
|     --data-urlencode type=direct \ | ||||
|     --data-urlencode 'to=[9, 10]' \ | ||||
|     --data-urlencode 'content=Can we meet on Monday?' \ | ||||
|     --data-urlencode scheduled_delivery_timestamp=3165826990 | ||||
|  | ||||
| ``` | ||||
|  | ||||
| {end_tabs} | ||||
|  | ||||
| ## Parameters | ||||
|  | ||||
| {generate_api_arguments_table|zulip.yaml|/scheduled_messages:post} | ||||
|  | ||||
| {generate_parameter_description(/scheduled_messages:post)} | ||||
|  | ||||
| ## Response | ||||
|  | ||||
| {generate_return_values_table|zulip.yaml|/scheduled_messages:post} | ||||
|  | ||||
| {generate_response_description(/scheduled_messages:post)} | ||||
|  | ||||
| #### Example response(s) | ||||
|  | ||||
| {generate_code_example|/scheduled_messages:post|fixture} | ||||
| @@ -1,6 +0,0 @@ | ||||
| # Create a channel | ||||
|  | ||||
| You can create a channel using Zulip's REST API by submitting a | ||||
| [subscribe](/api/subscribe) request with a channel name that | ||||
| doesn't yet exist and passing appropriate parameters to define | ||||
| the initial configuration of the new channel. | ||||
| @@ -1,90 +0,0 @@ | ||||
| # Group-setting values | ||||
|  | ||||
| Settings defining permissions in Zulip are increasingly represented | ||||
| using [user groups](/help/user-groups), which offer much more flexible | ||||
| configuration than the older [roles](/api/roles-and-permissions) system. | ||||
|  | ||||
| !!! warn "" | ||||
|  | ||||
|     This API feature is under development, and currently only values that | ||||
|     correspond to a single named user group are permitted in | ||||
|     production environments, pending the web application UI supporting | ||||
|     displaying more complex values correctly. | ||||
|  | ||||
| In the API, these settings are represented using a **group-setting | ||||
| value**, which can take two forms: | ||||
|  | ||||
| - An integer user group ID, which can be either a named user group | ||||
|   visible in the UI or a [role-based system group](#system-groups). | ||||
| - An object with fields `direct_member_ids` containing a list of | ||||
|   integer user IDs and `direct_subgroup_ids` containing a list of | ||||
|   integer group IDs. The setting's value is the union of the | ||||
|   identified collection of users and groups. | ||||
|  | ||||
| Group-setting values in the object form function very much like a | ||||
| formal user group object, without requiring the naming and UI clutter | ||||
| overhead involved with creating a visible user group just to store the | ||||
| value of a single setting. | ||||
|  | ||||
| The server will canonicalize an object with empty `direct_member_ids` | ||||
| and with `direct_subgroup_ids` containing just the given group ID to | ||||
| the integer format. | ||||
|  | ||||
| ## System groups | ||||
|  | ||||
| The Zulip server maintains a collection of system groups that | ||||
| correspond to the users with a given role; this makes it convenient to | ||||
| store concepts like "all administrators" in a group-setting | ||||
| value. These use a special naming convention and can be recognized by | ||||
| the `is_system_group` property on their group object. | ||||
|  | ||||
| The following system groups are maintained by the Zulip server: | ||||
|  | ||||
| - `role:internet`: Everyone on the Internet has this permission; this | ||||
|   is used to configure the [public access | ||||
|   option](/help/public-access-option). | ||||
| - `role:everyone`: All users, including guests. | ||||
| - `role:members`: All users, excluding guests. | ||||
| - `role:fullmembers`: All [full | ||||
|   members](https://zulip.com/api/roles-and-permissions#determining-if-a-user-is-a-full-member) | ||||
|   of the organization. | ||||
| - `role:moderators`: All users with at least the moderator role. | ||||
| - `role:administrators`: All users with at least the administrator | ||||
|   role. | ||||
| - `role:owners`: All users with the owner role. | ||||
| - `role:nobody`: The formal empty group. Used in the API to represent | ||||
|   disabling a feature. | ||||
|  | ||||
| Client UI for setting a permission is encouraged to display system | ||||
| groups using their description, rather than using their names, which | ||||
| are chosen to be unique and clear in the API. | ||||
|  | ||||
| System groups should generally not be displayed in UI for | ||||
| administering an organization's user groups, since they are not | ||||
| directly mutable. | ||||
|  | ||||
| ## Updating group-setting values | ||||
|  | ||||
| The Zulip API uses a special format for modifying an existing setting | ||||
| using a group-setting value. | ||||
|  | ||||
| A **group-setting update** is an object with a `new` field and an | ||||
| optional `old` field, each containing a group-setting value. The | ||||
| setting's value will be set to the membership expressed by the `new` | ||||
| field. | ||||
|  | ||||
| The `old` field expresses the client's understanding of the current | ||||
| value of the setting. If the `old` field is present and does not match | ||||
| the actual current value of the setting, then the request will fail | ||||
| with error code `EXPECTATION_MISMATCH` and no changes will be applied. | ||||
|  | ||||
| When a user edits the setting in a UI, the resulting API request | ||||
| should generally always include the `old` field, giving the value | ||||
| the list had when the user started editing. This accurately expresses | ||||
| the user's intent, and if two users edit the same list around the | ||||
| same time, it prevents a situation where the second change | ||||
| accidentally reverts the first one without either user noticing. | ||||
|  | ||||
| Omitting `old` is appropriate where the intent really is a new complete | ||||
| list rather than an edit, for example in an integration that syncs the | ||||
| list from an external source of truth. | ||||
| @@ -1,80 +0,0 @@ | ||||
| # HTTP headers | ||||
|  | ||||
| This page documents the HTTP headers used by the Zulip API. | ||||
|  | ||||
| Most important is that API clients authenticate to the server using | ||||
| HTTP Basic authentication. If you're using the official [Python or | ||||
| JavaScript bindings](/api/installation-instructions), this is taken | ||||
| care of when you configure said bindings. | ||||
|  | ||||
| Otherwise, see the `curl` example on each endpoint's documentation | ||||
| page, which details the request format. | ||||
|  | ||||
| Documented below are additional HTTP headers and header conventions | ||||
| generally used by Zulip: | ||||
|  | ||||
| ## The `User-Agent` header | ||||
|  | ||||
| Clients are not required to pass a `User-Agent` HTTP header, but we | ||||
| highly recommend doing so when writing an integration. It's easy to do | ||||
| and it can help save time when debugging issues related to an API | ||||
| client. | ||||
|  | ||||
| If provided, the Zulip server will parse the `User-Agent` HTTP header | ||||
| in order to identify specific clients and integrations. This | ||||
| information is used by the server for logging, [usage | ||||
| statistics](/help/analytics), and on rare occasions, for | ||||
| backwards-compatibility logic to preserve support for older versions | ||||
| of official clients. | ||||
|  | ||||
| Official Zulip clients and integrations use a `User-Agent` that starts | ||||
| with something like `ZulipMobile/20.0.103 `, encoding the name of the | ||||
| application and it's version. | ||||
|  | ||||
| Zulip's official API bindings have reasonable defaults for | ||||
| `User-Agent`. For example, the official Zulip Python bindings have a | ||||
| default `User-Agent` starting with `ZulipPython/{version}`, where | ||||
| `version` is the version of the library. | ||||
|  | ||||
| You can give your bot/integration its own name by passing the `client` | ||||
| parameter when initializing the Python bindings. For example, the | ||||
| official Zulip Nagios integration is initialized like this: | ||||
|  | ||||
| ``` python | ||||
| client = zulip.Client( | ||||
|     config_file=opts.config, client=f"ZulipNagios/{VERSION}" | ||||
| ) | ||||
| ``` | ||||
|  | ||||
| If you are working on an integration that you plan to share outside | ||||
| your organization, you can get help picking a good name in | ||||
| `#integrations` in the [Zulip development | ||||
| community](https://zulip.com/development-community/). | ||||
|  | ||||
| ## Rate-limiting response headers | ||||
|  | ||||
| To help clients avoid exceeding rate limits, Zulip sets the following | ||||
| HTTP headers in all API responses: | ||||
|  | ||||
| * `X-RateLimit-Remaining`: The number of additional requests of this | ||||
|   type that the client can send before exceeding its limit. | ||||
| * `X-RateLimit-Limit`: The limit that would be applicable to a client | ||||
|   that had not made any recent requests of this type. This is useful | ||||
|   for designing a client's burst behavior so as to avoid ever reaching | ||||
|   a rate limit. | ||||
| * `X-RateLimit-Reset`: The time at which the client will no longer | ||||
|   have any rate limits applied to it (and thus could do a burst of | ||||
|   `X-RateLimit-Limit` requests). | ||||
|  | ||||
| [Zulip's rate limiting rules are configurable][rate-limiting-rules], | ||||
| and can vary by server and over time. The default configuration | ||||
| currently limits: | ||||
|  | ||||
| * Every user is limited to 200 total API requests per minute. | ||||
| * Separate, much lower limits for authentication/login attempts. | ||||
|  | ||||
| When the Zulip server has configured multiple rate limits that apply | ||||
| to a given request, the values returned will be for the strictest | ||||
| limit. | ||||
|  | ||||
| [rate-limiting-rules]: https://zulip.readthedocs.io/en/latest/production/security-model.html#rate-limiting | ||||
| @@ -1,136 +0,0 @@ | ||||
| #### Messages | ||||
|  | ||||
| * [Send a message](/api/send-message) | ||||
| * [Upload a file](/api/upload-file) | ||||
| * [Edit a message](/api/update-message) | ||||
| * [Delete a message](/api/delete-message) | ||||
| * [Get messages](/api/get-messages) | ||||
| * [Construct a narrow](/api/construct-narrow) | ||||
| * [Add an emoji reaction](/api/add-reaction) | ||||
| * [Remove an emoji reaction](/api/remove-reaction) | ||||
| * [Render a message](/api/render-message) | ||||
| * [Fetch a single message](/api/get-message) | ||||
| * [Check if messages match a narrow](/api/check-messages-match-narrow) | ||||
| * [Get a message's edit history](/api/get-message-history) | ||||
| * [Update personal message flags](/api/update-message-flags) | ||||
| * [Update personal message flags for narrow](/api/update-message-flags-for-narrow) | ||||
| * [Mark all messages as read](/api/mark-all-as-read) | ||||
| * [Mark messages in a channel as read](/api/mark-stream-as-read) | ||||
| * [Mark messages in a topic as read](/api/mark-topic-as-read) | ||||
| * [Get a message's read receipts](/api/get-read-receipts) | ||||
|  | ||||
| #### Scheduled messages | ||||
|  | ||||
| * [Get scheduled messages](/api/get-scheduled-messages) | ||||
| * [Create a scheduled message](/api/create-scheduled-message) | ||||
| * [Edit a scheduled message](/api/update-scheduled-message) | ||||
| * [Delete a scheduled message](/api/delete-scheduled-message) | ||||
|  | ||||
| #### Drafts | ||||
|  | ||||
| * [Get drafts](/api/get-drafts) | ||||
| * [Create drafts](/api/create-drafts) | ||||
| * [Edit a draft](/api/edit-draft) | ||||
| * [Delete a draft](/api/delete-draft) | ||||
|  | ||||
| #### Channels | ||||
|  | ||||
| * [Get subscribed channels](/api/get-subscriptions) | ||||
| * [Subscribe to a channel](/api/subscribe) | ||||
| * [Unsubscribe from a channel](/api/unsubscribe) | ||||
| * [Get subscription status](/api/get-subscription-status) | ||||
| * [Get channel subscribers](/api/get-subscribers) | ||||
| * [Update subscription settings](/api/update-subscription-settings) | ||||
| * [Get all channels](/api/get-streams) | ||||
| * [Get a channel by ID](/api/get-stream-by-id) | ||||
| * [Get channel ID](/api/get-stream-id) | ||||
| * [Create a channel](/api/create-stream) | ||||
| * [Update a channel](/api/update-stream) | ||||
| * [Archive a channel](/api/archive-stream) | ||||
| * [Get channel's email address](/api/get-stream-email-address) | ||||
| * [Get topics in a channel](/api/get-stream-topics) | ||||
| * [Topic muting](/api/mute-topic) | ||||
| * [Update personal preferences for a topic](/api/update-user-topic) | ||||
| * [Delete a topic](/api/delete-topic) | ||||
| * [Add a default channel](/api/add-default-stream) | ||||
| * [Remove a default channel](/api/remove-default-stream) | ||||
|  | ||||
| #### Users | ||||
|  | ||||
| * [Get a user](/api/get-user) | ||||
| * [Get a user by email](/api/get-user-by-email) | ||||
| * [Get own user](/api/get-own-user) | ||||
| * [Get all users](/api/get-users) | ||||
| * [Create a user](/api/create-user) | ||||
| * [Update a user](/api/update-user) | ||||
| * [Deactivate a user](/api/deactivate-user) | ||||
| * [Deactivate own user](/api/deactivate-own-user) | ||||
| * [Reactivate a user](/api/reactivate-user) | ||||
| * [Get a user's status](/api/get-user-status) | ||||
| * [Update your status](/api/update-status) | ||||
| * [Set "typing" status](/api/set-typing-status) | ||||
| * [Get a user's presence](/api/get-user-presence) | ||||
| * [Get presence of all users](/api/get-presence) | ||||
| * [Update your presence](/api/update-presence) | ||||
| * [Get attachments](/api/get-attachments) | ||||
| * [Delete an attachment](/api/remove-attachment) | ||||
| * [Update settings](/api/update-settings) | ||||
| * [Get user groups](/api/get-user-groups) | ||||
| * [Create a user group](/api/create-user-group) | ||||
| * [Update a user group](/api/update-user-group) | ||||
| * [Delete a user group](/api/remove-user-group) | ||||
| * [Update user group members](/api/update-user-group-members) | ||||
| * [Update subgroups of a user group](/api/update-user-group-subgroups) | ||||
| * [Get user group membership status](/api/get-is-user-group-member) | ||||
| * [Get user group members](/api/get-user-group-members) | ||||
| * [Get subgroups of a user group](/api/get-user-group-subgroups) | ||||
| * [Mute a user](/api/mute-user) | ||||
| * [Unmute a user](/api/unmute-user) | ||||
| * [Get all alert words](/api/get-alert-words) | ||||
| * [Add alert words](/api/add-alert-words) | ||||
| * [Remove alert words](/api/remove-alert-words) | ||||
|  | ||||
| #### Invitations | ||||
|  | ||||
| * [Get all invitations](/api/get-invites) | ||||
| * [Send invitations](/api/send-invites) | ||||
| * [Create a reusable invitation link](/api/create-invite-link) | ||||
| * [Resend an email invitation](/api/resend-email-invite) | ||||
| * [Revoke an email invitation](/api/revoke-email-invite) | ||||
| * [Revoke a reusable invitation link](/api/revoke-invite-link) | ||||
|  | ||||
| #### Server & organizations | ||||
|  | ||||
| * [Get server settings](/api/get-server-settings) | ||||
| * [Get linkifiers](/api/get-linkifiers) | ||||
| * [Add a linkifier](/api/add-linkifier) | ||||
| * [Update a linkifier](/api/update-linkifier) | ||||
| * [Remove a linkifier](/api/remove-linkifier) | ||||
| * [Reorder linkifiers](/api/reorder-linkifiers) | ||||
| * [Add a code playground](/api/add-code-playground) | ||||
| * [Remove a code playground](/api/remove-code-playground) | ||||
| * [Get all custom emoji](/api/get-custom-emoji) | ||||
| * [Upload custom emoji](/api/upload-custom-emoji) | ||||
| * [Deactivate custom emoji](/api/deactivate-custom-emoji) | ||||
| * [Get all custom profile fields](/api/get-custom-profile-fields) | ||||
| * [Reorder custom profile fields](/api/reorder-custom-profile-fields) | ||||
| * [Create a custom profile field](/api/create-custom-profile-field) | ||||
| * [Update realm-level defaults of user settings](/api/update-realm-user-settings-defaults) | ||||
|  | ||||
| #### Real-time events | ||||
|  | ||||
| * [Real time events API](/api/real-time-events) | ||||
| * [Register an event queue](/api/register-queue) | ||||
| * [Get events from an event queue](/api/get-events) | ||||
| * [Delete an event queue](/api/delete-queue) | ||||
|  | ||||
| #### Specialty endpoints | ||||
|  | ||||
| * [Fetch an API key (production)](/api/fetch-api-key) | ||||
| * [Fetch an API key (development only)](/api/dev-fetch-api-key) | ||||
| * [Send a test notification to mobile device(s)](/api/test-notify) | ||||
| * [Add an APNs device token](/api/add-apns-token) | ||||
| * [Remove an APNs device token](/api/remove-apns-token) | ||||
| * [Add an FCM registration token](/api/add-fcm-token) | ||||
| * [Remove an FCM registration token](/api/remove-fcm-token) | ||||
| * [Create BigBlueButton video call](/api/create-big-blue-button-video-call) | ||||
| @@ -1,223 +0,0 @@ | ||||
| # Incoming webhook integrations | ||||
|  | ||||
| An incoming webhook allows a third-party service to push data to Zulip when | ||||
| something happens. There are several ways to set up an incoming webhook in | ||||
| Zulip: | ||||
|  | ||||
| * Use our [REST API](/api/rest) endpoint for [sending | ||||
|   messages](/api/send-message).  This works great for internal tools | ||||
|   or cases where the third-party tool wants to control the formatting | ||||
|   of the messages in Zulip. | ||||
| * Use one of our supported [integration | ||||
|   frameworks](/integrations/meta-integration), such as the | ||||
|   [Slack-compatible incoming webhook](/integrations/doc/slack_incoming), | ||||
|   [Zapier integration](/integrations/doc/zapier), or | ||||
|   [IFTTT integration](/integrations/doc/ifttt). | ||||
| * Implementing an incoming webhook integration (detailed on this page), | ||||
|   where all the logic for formatting the Zulip messages lives in the | ||||
|   Zulip server.  This is how most of [Zulip's official | ||||
|   integrations](/integrations/) work, because they enable Zulip to | ||||
|   support third-party services that just have an "outgoing webhook" | ||||
|   feature (without the third party needing to do any work specific to | ||||
|   Zulip). | ||||
|  | ||||
| In an incoming webhook integration, the third-party service's | ||||
| "outgoing webhook" feature sends an `HTTP POST` to a special URL when | ||||
| it has something for you, and then the Zulip "incoming webhook" | ||||
| integration handles that incoming data to format and send a message in | ||||
| Zulip. | ||||
|  | ||||
| New official Zulip webhook integrations can take just a few hours to | ||||
| write, including tests and documentation, if you use the right | ||||
| process. | ||||
|  | ||||
| ## Quick guide | ||||
|  | ||||
| * Set up the | ||||
|   [Zulip development environment](https://zulip.readthedocs.io/en/latest/development/overview.html). | ||||
|  | ||||
| * Use [Zulip's JSON integration](/integrations/doc/json), | ||||
|   <https://webhook.site/>, or a similar site to capture an example | ||||
|   webhook payload from the third-party service. Create a | ||||
|   `zerver/webhooks/<mywebhook>/fixtures/` directory, and add the | ||||
|   captured JSON payload as a test fixture. | ||||
|  | ||||
| * Create an `Integration` object, and add it to the `WEBHOOK_INTEGRATIONS` | ||||
|   list in `zerver/lib/integrations.py`. Search for `WebhookIntegration` in that | ||||
|   file to find an existing one to copy. | ||||
|  | ||||
| * Write a draft webhook handler in `zerver/webhooks/<mywebhook>/view.py`. There | ||||
|   are a lot of examples in the `zerver/webhooks/` directory that you can copy. | ||||
|   We recommend templating from a short one, like `zendesk`. | ||||
|  | ||||
| * Write a test for your fixture in `zerver/webhooks/<mywebhook>/tests.py`. | ||||
|   Run the test for your integration like this: | ||||
|  | ||||
|     ``` | ||||
|     tools/test-backend zerver/webhooks/<mywebhook>/ | ||||
|     ``` | ||||
|  | ||||
|     Iterate on debugging the test and webhooks handler until it all | ||||
|     works. | ||||
|  | ||||
| * Capture payloads for the other common types of `POST`s the third-party | ||||
|   service will make, and add tests for them; usually this part of the | ||||
|   process is pretty fast. | ||||
|  | ||||
| * Document the integration in `zerver/webhooks/<mywebhook>/doc.md`(required for | ||||
|   getting it merged into Zulip). You can use existing documentation, like | ||||
|   [this one](https://raw.githubusercontent.com/zulip/zulip/main/zerver/webhooks/github/doc.md), | ||||
|   as a template. This should not take more than 15 minutes, even if you don't speak English | ||||
|   as a first language (we'll clean up the text before merging). | ||||
|  | ||||
| ## Hello world walkthrough | ||||
|  | ||||
| Check out the [detailed walkthrough](incoming-webhooks-walkthrough) for step-by-step | ||||
| instructions. | ||||
|  | ||||
| ## Checklist | ||||
|  | ||||
| ### Files that need to be created | ||||
|  | ||||
| Select a name for your incoming webhook and use it consistently. The examples | ||||
| below are for a webhook named `MyWebHook`. | ||||
|  | ||||
| * `zerver/webhooks/mywebhook/__init__.py`: Empty file that is an obligatory | ||||
|    part of every python package.  Remember to `git add` it. | ||||
| * `zerver/webhooks/mywebhook/view.py`: The main webhook integration function, | ||||
|   called `api_mywebhook_webhook`, along with any necessary helper functions. | ||||
| * `zerver/webhooks/mywebhook/fixtures/message_type.json`: Sample JSON payload data | ||||
|   used by tests. Add one fixture file per type of message supported by your | ||||
|   integration. | ||||
| * `zerver/webhooks/mywebhook/tests.py`: Tests for your webhook. | ||||
| * `zerver/webhooks/mywebhook/doc.md`: End-user documentation explaining | ||||
|   how to add the integration. | ||||
| * `static/images/integrations/logos/mywebhook.svg`: A square logo for the | ||||
|   platform/server/product you are integrating. Used on the documentation | ||||
|   pages as well as the sender's avatar for messages sent by the integration. | ||||
| * `static/images/integrations/mywebhook/001.png`: A screenshot of a message | ||||
|   sent by the integration, used on the documentation page. This can be | ||||
|   generated by running `tools/screenshots/generate-integration-docs-screenshot --integration mywebhook`. | ||||
| * `static/images/integrations/bot_avatars/mywebhook.png`: A square logo for the | ||||
|   platform/server/product you are integrating which is used to create the avatar | ||||
|   for generating screenshots with. This can be generated automatically from | ||||
|   `static/images/integrations/logos/mywebhook.svg` by running | ||||
|   `tools/setup/generate_integration_bots_avatars.py`. | ||||
|  | ||||
| ### Files that need to be updated | ||||
|  | ||||
| * `zerver/lib/integrations.py`: Add your integration to | ||||
|   `WEBHOOK_INTEGRATIONS`. This will automatically register a | ||||
|   URL for the incoming webhook of the form `api/v1/external/mywebhook` and | ||||
|   associate it with the function called `api_mywebhook_webhook` in | ||||
|   `zerver/webhooks/mywebhook/view.py`. Also add your integration to | ||||
|   `DOC_SCREENSHOT_CONFIG`. This will allow you to automatically generate | ||||
|   a screenshot for the documentation by running | ||||
|   `tools/screenshots/generate-integration-docs-screenshot --integration mywebhook`. | ||||
|  | ||||
| ## Common Helpers | ||||
|  | ||||
| * If your integration will receive a test webhook payload, you can use | ||||
|   `get_setup_webhook_message` to create our standard message for test payloads. | ||||
|   You can import this from `zerver/lib/webhooks/common.py`, and it will generate | ||||
|   a message like this: "GitHub webhook is successfully configured! 🎉" | ||||
|  | ||||
| ## General advice | ||||
|  | ||||
| * Consider using our Zulip markup to make the output from your | ||||
|   integration especially attractive or useful (e.g., emoji, Markdown | ||||
|   emphasis, or @-mentions). | ||||
|  | ||||
| * Use topics effectively to ensure sequential messages about the same | ||||
|   thing are threaded together; this makes for much better consumption | ||||
|   by users.  E.g., for a bug tracker integration, put the bug number in | ||||
|   the topic for all messages; for an integration like Nagios, put the | ||||
|   service in the topic. | ||||
|  | ||||
| * Integrations that don't match a team's workflow can often be | ||||
|   uselessly spammy.  Give careful thought to providing options for | ||||
|   triggering Zulip messages only for certain message types, certain | ||||
|   projects, or sending different messages to different channels/topics, | ||||
|   to make it easy for teams to configure the integration to support | ||||
|   their workflow. | ||||
|  | ||||
| * Consistently capitalize the name of the integration in the | ||||
|   documentation and the Client name the way the vendor does.  It's OK | ||||
|   to use all-lower-case in the implementation. | ||||
|  | ||||
| * Sometimes it can be helpful to contact the vendor if it appears they | ||||
|   don't have an API or webhook we can use; sometimes the right API | ||||
|   is just not properly documented. | ||||
|  | ||||
| * A helpful tool for testing your integration is | ||||
|   [UltraHook](http://www.ultrahook.com/), which allows you to receive webhook | ||||
|   calls via your local Zulip development environment. This enables you to do end-to-end | ||||
|   testing with live data from the service you're integrating and can help you | ||||
|   spot why something isn't working or if the service is using custom HTTP | ||||
|   headers. | ||||
|  | ||||
| ## URL specification | ||||
|  | ||||
| The base URL for an incoming webhook integration bot, where | ||||
| `INTEGRATION_NAME` is the name of the specific webhook integration and | ||||
| `API_KEY` is the API key of the bot created by the user for the | ||||
| integration, is: | ||||
|  | ||||
| ``` | ||||
| {{ api_url }}/v1/external/INTEGRATION_NAME?api_key=API_KEY | ||||
| ``` | ||||
|  | ||||
| The list of existing webhook integrations can be found by browsing the | ||||
| [Integrations documentation](/integrations/) or in | ||||
| `zerver/lib/integrations.py` at `WEBHOOK_INTEGRATIONS`. | ||||
|  | ||||
| Parameters accepted in the URL include: | ||||
|  | ||||
| ### api_key *(required)* | ||||
|  | ||||
| The API key of the bot created by the user for the integration. To get a | ||||
| bot's API key, see the [API keys](/api/api-keys) documentation. | ||||
|  | ||||
| ### stream | ||||
|  | ||||
| The channel for the integration to send notifications to. Can be either | ||||
| the channel ID or the [URL-encoded][url-encoder] channel name. By default | ||||
| the integration will send direct messages to the bot's owner. | ||||
|  | ||||
| !!! tip "" | ||||
|  | ||||
|     A channel ID can be found when [browsing channels][browse-channels] | ||||
|     in the web or desktop apps. | ||||
|  | ||||
| ### topic | ||||
|  | ||||
| The topic in the specified channel for the integration to send | ||||
| notifications to. The topic should also be [URL-encoded][url-encoder]. | ||||
| By default the integration will have a topic configured for channel | ||||
| messages. | ||||
|  | ||||
| ### only_events, exclude_events | ||||
|  | ||||
| Some incoming webhook integrations support these parameters to filter | ||||
| which events will trigger a notification. You can append either | ||||
| `&only_events=["event_a","event_b"]` or | ||||
| `&exclude_events=["event_a","event_b"]` (or both, with different events) | ||||
| to the URL, with an arbitrary number of supported events. | ||||
|  | ||||
| You can use UNIX-style wildcards like `*` to include multiple events. | ||||
| For example, `test*` matches every event that starts with `test`. | ||||
|  | ||||
| !!! tip "" | ||||
|  | ||||
|     For a list of supported events, see a specific [integration's | ||||
|     documentation](/integrations) page. | ||||
|  | ||||
| [browse-channels]: /help/introduction-to-channels#browse-and-subscribe-to-channels | ||||
| [add-bot]: /help/add-a-bot-or-integration | ||||
| [url-encoder]: https://www.urlencoder.org/ | ||||
|  | ||||
| ## Related articles | ||||
|  | ||||
| * [Integrations overview](/api/integrations-overview) | ||||
| * [Incoming webhook walkthrough](/api/incoming-webhooks-walkthrough) | ||||
| * [Non-webhook integrations](/api/non-webhook-integrations) | ||||
| @@ -1,26 +0,0 @@ | ||||
| # The Zulip API | ||||
|  | ||||
| Zulip's APIs allow you to integrate other services with Zulip.  This | ||||
| guide should help you find the API you need: | ||||
|  | ||||
| * First, check if the tool you'd like to integrate with Zulip | ||||
|   [already has a native integration](/integrations/). | ||||
| * Next, check if [Zapier](https://zapier.com/apps) or | ||||
|   [IFTTT](https://ifttt.com/search) has an integration. | ||||
|   [Zulip's Zapier integration](/integrations/doc/zapier) and | ||||
|   [Zulip's IFTTT integration](/integrations/doc/ifttt) often allow | ||||
|   integrating a new service with Zulip without writing any code. | ||||
| * If you'd like to send content into Zulip, you can | ||||
|   [write a native incoming webhook integration](/api/incoming-webhooks-overview) | ||||
|   or use [Zulip's API for sending messages](/api/send-message). | ||||
| * If you're building an interactive bot that reacts to activity inside | ||||
|   Zulip, you'll want to look at Zulip's | ||||
|   [Python framework for interactive bots](/api/running-bots) or | ||||
|   [Zulip's real-time events API](/api/get-events). | ||||
|  | ||||
| And if you still need to build your own integration with Zulip, check out | ||||
| the full [REST API](/api/rest), generally starting with | ||||
| [installing the API client bindings](/api/installation-instructions). | ||||
|  | ||||
| In case you already know how you want to build your integration and you're | ||||
| just looking for an API key, we've got you covered [here](/api/api-keys). | ||||
| @@ -1,77 +0,0 @@ | ||||
| # Integrations overview | ||||
|  | ||||
| Integrations allow you to send data from other products into or out of | ||||
| Zulip. Zulip natively integrates with dozens of products, and with hundreds | ||||
| more through Zapier and IFTTT. | ||||
|  | ||||
| Zulip also makes it very easy to write your own integration, and (if you'd | ||||
| like) to get it merged into the main Zulip repository. | ||||
|  | ||||
| Integrations are one of the most important parts of a group chat tool like | ||||
| Zulip, and we are committed to making integrating with Zulip as easy as | ||||
| possible. | ||||
|  | ||||
| ## Set up an existing integration | ||||
|  | ||||
| Most existing integrations send content from a third-party product into | ||||
| Zulip. | ||||
|  | ||||
| * Search Zulip's [list of native integrations](/integrations/) for the | ||||
|   third-party product. Each integration has a page describing how to set it | ||||
|   up. | ||||
|  | ||||
| * Check if [Zapier](https://zapier.com/apps) has an integration with the | ||||
|   product. If it does, follow [these instructions](/integrations/doc/zapier) | ||||
|   to set it up. | ||||
|  | ||||
| * Check if [IFTTT](https://ifttt.com/search) has an integration with the | ||||
|   product. If it does, follow [these instructions](/integrations/doc/ifttt) | ||||
|   to set it up. | ||||
|  | ||||
| * Use a third-party webhook integration designed to work with | ||||
|   [Slack's webhook API](https://api.slack.com/messaging/webhooks) | ||||
|   pointed at Zulip's | ||||
|   [Slack-compatible webhook API](/integrations/slack/slack_incoming). | ||||
|  | ||||
| * If the product can send email notifications, you can | ||||
|   [send those emails to a channel](/help/message-a-channel-by-email). | ||||
|  | ||||
| ## Write your own integration | ||||
|  | ||||
| We've put a lot of effort into making this as easy as possible, but | ||||
| all of the options below do require some comfort writing code. If you | ||||
| need an integration and don't have an engineer on staff, [contact | ||||
| us](/help/contact-support) and we'll see what we can do. | ||||
|  | ||||
| ### Sending content into Zulip | ||||
|  | ||||
| * If the third-party service supports outgoing webhooks, you likely want to | ||||
|   build an [incoming webhook integration](/api/incoming-webhooks-overview). | ||||
|  | ||||
| * If it doesn't, you may want to write a | ||||
|   [script or plugin integration](/api/non-webhook-integrations). | ||||
|  | ||||
| * Finally, you can | ||||
|   [send messages using Zulip's API](/api/send-message). | ||||
|  | ||||
| ### Sending and receiving content | ||||
|  | ||||
| * To react to activity inside Zulip, look at Zulip's | ||||
|   [Python framework for interactive bots](/api/running-bots) or | ||||
|   [Zulip's real-time events API](/api/get-events). | ||||
|  | ||||
| * If what you want isn't covered by the above, check out the full | ||||
|   [REST API](/api/rest). The web, mobile, desktop, and terminal apps are | ||||
|   built on top of this API, so it can do anything a human user can do. Most | ||||
|   but not all of the endpoints are documented on this site; if you need | ||||
|   something that isn't there check out Zulip's | ||||
|   [REST endpoints](https://github.com/zulip/zulip/blob/main/zproject/urls.py) | ||||
|   or [contact us](/help/contact-support) and we'll help you out. | ||||
|  | ||||
| ## Related articles | ||||
|  | ||||
| * [Bots overview](/help/bots-overview) | ||||
| * [Set up integrations](/help/set-up-integrations) | ||||
| * [Add a bot or integration](/help/add-a-bot-or-integration) | ||||
| * [Generate integration URL](/help/generate-integration-url) | ||||
| * [Request an integration](/help/request-an-integration) | ||||
| @@ -1,152 +0,0 @@ | ||||
| # Message formatting | ||||
|  | ||||
| Zulip supports an extended version of Markdown for messages, as well as | ||||
| some HTML level special behavior. The Zulip help center article on [message | ||||
| formatting](/help/format-your-message-using-markdown) is the primary | ||||
| documentation for Zulip's markup features. This article is currently a | ||||
| changelog for updates to these features. | ||||
|  | ||||
| The [render a message](/api/render-message) endpoint can be used to get | ||||
| the current HTML version of any Markdown syntax for message content. | ||||
|  | ||||
| ## Code blocks | ||||
|  | ||||
| **Changes**: As of Zulip 4.0 (feature level 33), [code blocks][help-code] | ||||
| can have a `data-code-language` attribute attached to the outer HTML | ||||
| `div` element, which records the programming language that was selected | ||||
| for syntax highlighting. This field is used in the | ||||
| [playgrounds][help-playgrounds] feature for code blocks. | ||||
|  | ||||
| ## Global times | ||||
|  | ||||
| **Changes**: In Zulip 3.0 (feature level 8), added [global time | ||||
| mentions][help-global-time] to supported Markdown message formatting | ||||
| features. | ||||
|  | ||||
| ## Image previews | ||||
|  | ||||
| When a Zulip message is sent linking to an uploaded image, Zulip will | ||||
| generate an image preview element with the following format. | ||||
|  | ||||
| ``` html | ||||
| <div class="message_inline_image"> | ||||
|     <a href="/user_uploads/path/to/image.png" title="image.png"> | ||||
|         <img data-original-dimensions="1920x1080" | ||||
|           src="/user_uploads/thumbnail/path/to/image.png/840x560.webp"> | ||||
|     </a> | ||||
| </div> | ||||
| ``` | ||||
|  | ||||
| If the server has not yet generated thumbnails for the image yet at | ||||
| the time the message is sent, the `img` element will be a temporary | ||||
| loading indicator image and have the `image-loading-placeholder` | ||||
| class, which clients can use to identify loading indicators and | ||||
| replace them with a more native loading indicator element if | ||||
| desired. For example: | ||||
|  | ||||
| ``` html | ||||
| <div class="message_inline_image"> | ||||
|     <a href="/user_uploads/path/to/image.png" title="image.png"> | ||||
|         <img class="image-loading-placeholder" src="/path/to/spinner.png"> | ||||
|     </a> | ||||
| </div> | ||||
| ``` | ||||
|  | ||||
| Once the server has a working thumbnail, such messages will be updated | ||||
| via an `update_message` event, with the `rendering_only: true` flag | ||||
| (telling clients not to adjust message edit history), with appropriate | ||||
| adjusted `rendered_content`. A client should process those events by | ||||
| just using the updated rendering. If thumbnailing failed, the same | ||||
| type of event will edit the message's rendered form to remove the | ||||
| image preview element, so no special client-side logic should be | ||||
| required to process such errors. | ||||
|  | ||||
| Note that in the uncommon situation that the thumbnailing system is | ||||
| backlogged, an individual message containing multiple image previews | ||||
| may be re-rendered multiple times as each image finishes thumbnailing | ||||
| and triggers a message update. | ||||
|  | ||||
| Clients are recommended to do the following when processing image | ||||
| previews: | ||||
|  | ||||
| - If the client would like to control the thumbnail resolution used, | ||||
|   it can replace the final section of the URL (`840x560.webp` in the | ||||
|   example above) with the `name` of its preferred format from the set | ||||
|   of supported formats provided by the server in the | ||||
|   `server_thumbnail_formats` portion of the `register` | ||||
|   response. Clients should not make any assumptions about what format | ||||
|   the server will use as the "default" thumbnail resolution, as it may | ||||
|   change over time. | ||||
| - Download button type elements should provide the original image | ||||
|   (encoded via the `href` of the containing `a` tag). | ||||
| - Lightbox elements for viewing an image should be designed to | ||||
|   immediately display any already-downloaded thumbnail while fetching | ||||
|   the original-quality image or an appropriate higher-quality | ||||
|   thumbnail from the server, to be transparently swapped in once it is | ||||
|   available. Clients that would like to size the lightbox based on the | ||||
|   size of the original image can use the `data-original-dimensions` | ||||
|   attribute, which encodes the dimensions of the original image as | ||||
|   `{width}x{height}`, to do so.  These dimensions are for the image as | ||||
|   rendered, _after_ any EXIF rotation and mirroring has been applied. | ||||
| - Animated images will have a `data-animated` attribute on the `img` | ||||
|   tag. As detailed in `server_thumbnail_formats`, both animated and | ||||
|   still images are available for clients to use, depending on their | ||||
|   preference. See, for example, the [web | ||||
|   setting](/help/allow-image-link-previews#configure-how-animated-images-are-played) | ||||
|   to control whether animated images are autoplayed in the message | ||||
|   feed. | ||||
| - Clients should not assume that the requested format is the format | ||||
|   that they will receive; in rare cases where the client has an | ||||
|   out-of-date list of `server_thumbnail_formats`, the server will | ||||
|   provide an approximation of the client's requested format.  Because | ||||
|   of this, clients should not assume that the pixel dimensions or file | ||||
|   format match what they requested. | ||||
| - No other processing of the URLs is recommended. | ||||
|  | ||||
| **Changes**: In Zulip 9.0 (feature level 276), added | ||||
| `data-original-dimensions` attribute to images that have been | ||||
| thumbnailed, containing the dimensions of the full-size version of the | ||||
| image. Thumbnailing itself was reintroduced at feature level 275. | ||||
|  | ||||
| Previously, with the exception of Zulip servers that used the beta | ||||
| Thumbor-based implementation years ago, all image previews in Zulip | ||||
| messages were not thumbnailed; the `a` tag and the `img` tag would both | ||||
| point to the original image. | ||||
|  | ||||
| Clients that correctly implement the current API should handle | ||||
| Thumbor-based older thumbnails correctly, as long as they do not | ||||
| assume that `data-original-dimension` is present. Clients should not | ||||
| assume that messages sent prior to the introduction of thumbnailing | ||||
| have been re-rendered to use the new format or have thumbnails | ||||
| available. | ||||
|  | ||||
| ## Mentions | ||||
|  | ||||
| **Changes**: In Zulip 9.0 (feature level 247), `channel` was added | ||||
| to the supported [wildcard][help-mention-all] options used in the | ||||
| [mentions][help-mentions] Markdown message formatting feature. | ||||
|  | ||||
| ## Spoilers | ||||
|  | ||||
| **Changes**: In Zulip 3.0 (feature level 15), added | ||||
| [spoilers][help-spoilers] to supported Markdown message formatting | ||||
| features. | ||||
|  | ||||
| ## Removed features | ||||
|  | ||||
| **Changes**: In Zulip 4.0 (feature level 24), the rarely used `!avatar()` | ||||
| and `!gravatar()` markup syntax, which was never documented and had an | ||||
| inconsistent syntax, were removed. | ||||
|  | ||||
| ## Related articles | ||||
|  | ||||
| * [Markdown formatting](/help/format-your-message-using-markdown) | ||||
| * [Send a message](/api/send-message) | ||||
| * [Render a message](/api/render-message) | ||||
|  | ||||
| [help-code]: /help/code-blocks | ||||
| [help-playgrounds]: /help/code-blocks#code-playgrounds | ||||
| [help-spoilers]: /help/spoilers | ||||
| [help-global-time]: /help/global-times | ||||
| [help-mentions]: /help/mention-a-user-or-group | ||||
| [help-mention-all]: /help/mention-a-user-or-group#mention-everyone-on-a-channel | ||||
| @@ -1,64 +0,0 @@ | ||||
| # Error handling | ||||
|  | ||||
| Zulip's API will always return a JSON format response. | ||||
| The HTTP status code indicates whether the request was successful | ||||
| (200 = success, 4xx = user error, 5xx = server error). | ||||
|  | ||||
| Every response, both success and error responses, will contain at least | ||||
| two keys: | ||||
|  | ||||
| - `msg`: an internationalized, human-readable error message string. | ||||
|  | ||||
| - `result`: either `"error"` or `"success"`, which is redundant with the | ||||
|   HTTP status code, but is convenient when print debugging. | ||||
|  | ||||
| Every error response will also contain an additional key: | ||||
|  | ||||
| - `code`: a machine-readable error string, with a default value of | ||||
|   `"BAD_REQUEST"` for general errors. | ||||
|  | ||||
| Clients should always check `code`, rather than `msg`, when looking for | ||||
| specific error conditions. The string values for `msg` are | ||||
| internationalized (e.g., the server will send the error message | ||||
| translated into French if the user has a French locale), so checking | ||||
| those strings will result in buggy code. | ||||
|  | ||||
| !!! tip "" | ||||
|  | ||||
|      If a client needs information that is only present in the string value | ||||
|      of `msg` for a particular error response, then the developers | ||||
|      implementing the client should [start a conversation here][api-design] | ||||
|      in order to discuss getting a specific error `code` and/or relevant | ||||
|      additional key/value pairs for that error response. | ||||
|  | ||||
| In addition to the keys described above, some error responses will | ||||
| contain other keys with further details that are useful for clients. The | ||||
| specific keys present depend on the error `code`, and are documented at | ||||
| the API endpoints where these particular errors appear. | ||||
|  | ||||
| **Changes**: Before Zulip 5.0 (feature level 76), all error responses | ||||
| did not contain a `code` key, and its absence indicated that no specific | ||||
| error `code` had been allocated for that error. | ||||
|  | ||||
| ## Common error responses | ||||
|  | ||||
| Documented below are some error responses that are common to many | ||||
| endpoints: | ||||
|  | ||||
| {generate_code_example|/rest-error-handling:post|fixture} | ||||
|  | ||||
| ## Ignored Parameters | ||||
|  | ||||
| In JSON success responses, all Zulip REST API endpoints may return | ||||
| an array of parameters sent in the request that are not supported | ||||
| by that specific endpoint. | ||||
|  | ||||
| While this can be expected, e.g., when sending both current and legacy | ||||
| names for a parameter to a Zulip server of unknown version, this often | ||||
| indicates either a bug in the client implementation or an attempt to | ||||
| configure a new feature while connected to an older Zulip server that | ||||
| does not support said feature. | ||||
|  | ||||
| {generate_code_example|/settings:patch|fixture} | ||||
|  | ||||
| [api-design]: https://chat.zulip.org/#narrow/channel/378-api-design | ||||
| @@ -1,125 +0,0 @@ | ||||
| # Roles and permissions | ||||
|  | ||||
| Zulip offers several levels of permissions based on a | ||||
| [user's role](/help/roles-and-permissions) in a Zulip organization. | ||||
|  | ||||
| Here are some important details to note when working with these | ||||
| roles and permissions in Zulip's API: | ||||
|  | ||||
| ## A user's role | ||||
|  | ||||
| A user's account data include a `role` property, which contains the | ||||
| user's role in the Zulip organization. These roles are encoded as: | ||||
|  | ||||
| * Organization owner: 100 | ||||
|  | ||||
| * Organization administrator: 200 | ||||
|  | ||||
| * Organization moderator: 300 | ||||
|  | ||||
| * Member: 400 | ||||
|  | ||||
| * Guest: 600 | ||||
|  | ||||
| User account data also include these boolean properties that duplicate | ||||
| the related roles above: | ||||
|  | ||||
| * `is_owner` specifying whether the user is an organization owner. | ||||
|  | ||||
| * `is_admin` specifying whether the user is an organization administrator. | ||||
|  | ||||
| * `is_guest` specifying whether the user is a guest user. | ||||
|  | ||||
| These are intended as conveniences for simple clients, and clients | ||||
| should prefer using the `role` field, since only that one is updated | ||||
| by the [events API](/api/get-events). | ||||
|  | ||||
| Note that [`POST /register`](/api/register-queue) also returns an | ||||
| `is_moderator` boolean property specifying whether the current user is | ||||
| an organization moderator. | ||||
|  | ||||
| Additionally, user account data include an `is_billing_admin` property | ||||
| specifying whether the user is a billing administrator for the Zulip | ||||
| organization, which is not related to one of the roles listed above, | ||||
| but rather allows for specific permissions related to billing | ||||
| administration in [paid Zulip Cloud plans](https://zulip.com/plans/). | ||||
|  | ||||
| ### User account data in the API | ||||
|  | ||||
| Endpoints that return the user account data / properties mentioned | ||||
| above are: | ||||
|  | ||||
| * [`GET /users`](/api/get-users) | ||||
|  | ||||
| * [`GET /users/{user_id}`](/api/get-user) | ||||
|  | ||||
| * [`GET /users/{email}`](/api/get-user-by-email) | ||||
|  | ||||
| * [`GET /users/me`](/api/get-own-user) | ||||
|  | ||||
| * [`GET /events`](/api/get-events) | ||||
|  | ||||
| * [`POST /register`](/api/register-queue) | ||||
|  | ||||
| Note that the [`POST /register` endpoint](/api/register-queue) returns | ||||
| the above boolean properties to describe the role of the current user, | ||||
| when `realm_user` is present in `fetch_event_types`. | ||||
|  | ||||
| Additionally, the specific events returned by the | ||||
| [`GET /events` endpoint](/api/get-events) containing data related | ||||
| to user accounts and roles are the [`realm_user` add | ||||
| event](/api/get-events#realm_user-add), and the | ||||
| [`realm_user` update event](/api/get-events#realm_user-update). | ||||
|  | ||||
| ## Permission levels | ||||
|  | ||||
| Many areas of Zulip are customizable by the roles | ||||
| above, such as (but not limited to) [restricting message editing and | ||||
| deletion](/help/restrict-message-editing-and-deletion) and | ||||
| [channels permissions](/help/channel-permissions). The potential | ||||
| permission levels are: | ||||
|  | ||||
| * Everyone / Any user including Guests (least restrictive) | ||||
|  | ||||
| * Members | ||||
|  | ||||
| * Full members | ||||
|  | ||||
| * Moderators | ||||
|  | ||||
| * Administrators | ||||
|  | ||||
| * Owners | ||||
|  | ||||
| * Nobody (most restrictive) | ||||
|  | ||||
| These permission levels and policies in the API are designed to be | ||||
| cutoffs in that users with the specified role and above have the | ||||
| specified ability or access. For example, a permission level documented | ||||
| as 'moderators only' includes organization moderators, administrators, | ||||
| and owners. | ||||
|  | ||||
| Note that specific settings and policies in the Zulip API that use these | ||||
| permission levels will likely support a subset of those listed above. | ||||
|  | ||||
| ## Group-based permissions | ||||
|  | ||||
| Some settings have been migrated to a more flexible system based on | ||||
| [user groups](/api/group-setting-values). | ||||
|  | ||||
| ## Determining if a user is a full member | ||||
|  | ||||
| When a Zulip organization has set up a [waiting period before new members | ||||
| turn into full members](/help/restrict-permissions-of-new-members), | ||||
| clients will need to determine if a user's account has aged past the | ||||
| organization's waiting period threshold. | ||||
|  | ||||
| The `realm_waiting_period_threshold`, which is the number of days until | ||||
| a user's account is treated as a full member, is returned by the | ||||
| [`POST /register` endpoint](/api/register-queue) when `realm` is present | ||||
| in `fetch_event_types`. | ||||
|  | ||||
| Clients can compare the `realm_waiting_period_threshold` to a user | ||||
| accounts's `date_joined` property, which is the time the user account | ||||
| was created, to determine if a user has the permissions of a full | ||||
| member or a new member. | ||||
| @@ -1,74 +0,0 @@ | ||||
| # Interactive bots | ||||
|  | ||||
| Zulip's API has a powerful framework for interactive bots that react | ||||
| to messages in Zulip. | ||||
|  | ||||
| ## Running a bot | ||||
|  | ||||
| This guide will show you how to run an existing Zulip bot | ||||
| found in [zulip_bots/bots]( | ||||
| https://github.com/zulip/python-zulip-api/tree/main/zulip_bots/zulip_bots/bots). | ||||
|  | ||||
| You'll need: | ||||
|  | ||||
| * An account in a Zulip organization | ||||
|   (e.g., [the Zulip development community](https://zulip.com/development-community/), | ||||
|   `<yourSubdomain>.zulipchat.com`, or a Zulip organization on your own | ||||
|   [development](https://zulip.readthedocs.io/en/latest/development/overview.html) or | ||||
|   [production](https://zulip.readthedocs.io/en/latest/production/install.html) server). | ||||
| * A computer where you're running the bot from. | ||||
|  | ||||
| **Note: Please be considerate when testing experimental bots on public servers such as chat.zulip.org.** | ||||
|  | ||||
| {start_tabs} | ||||
|  | ||||
| 1. [Create a bot](/help/add-a-bot-or-integration), making sure to select | ||||
|    **Generic bot** as the **Bot type**. | ||||
|  | ||||
| 1. [Download the bot's `zuliprc` file](/api/configuring-python-bindings#download-a-zuliprc-file). | ||||
|  | ||||
| 1. Use the following command to install the | ||||
|    [`zulip_bots` Python package](https://pypi.org/project/zulip-bots/): | ||||
|  | ||||
|         pip3 install zulip_bots | ||||
|  | ||||
| 1. Use the following command to start the bot process *(replacing | ||||
|    `~/path/to/zuliprc` with the path to the `zuliprc` file you downloaded above)*: | ||||
|  | ||||
|         zulip-run-bot <bot-name> --config-file ~/path/to/zuliprc | ||||
|  | ||||
| 1. Check the output of the command above to make sure your bot is running. | ||||
|    It should include the following line: | ||||
|  | ||||
|         INFO:root:starting message handling... | ||||
|  | ||||
| 1. Test your setup by [starting a new direct message](/help/starting-a-new-direct-message) | ||||
|    with the bot or [mentioning](/help/mention-a-user-or-group) the bot on a channel. | ||||
|  | ||||
| !!! tip "" | ||||
|  | ||||
|     To use the latest development version of the `zulip_bots` package, follow | ||||
|     [these steps](writing-bots#installing-a-development-version-of-the-zulip-bots-package). | ||||
|  | ||||
| {end_tabs} | ||||
|  | ||||
| You can now play around with the bot and get it configured the way you | ||||
| like.  Eventually, you'll probably want to run it in a production | ||||
| environment where it'll stay up, by [deploying](/api/deploying-bots) it on a | ||||
| server using the Zulip Botserver. | ||||
|  | ||||
| ## Common problems | ||||
|  | ||||
| * My bot won't start | ||||
|     * Ensure that your API config file is correct (download the config file from the server). | ||||
|     * Ensure that your bot script is located in `zulip_bots/bots/<my-bot>/` | ||||
|     * Are you using your own Zulip development server? Ensure that you run your bot outside | ||||
|       the Vagrant environment. | ||||
|     * Some bots require Python 3. Try switching to a Python 3 environment before running | ||||
|       your bot. | ||||
|  | ||||
| ## Related articles | ||||
|  | ||||
| * [Non-webhook integrations](/api/non-webhook-integrations) | ||||
| * [Deploying bots](/api/deploying-bots) | ||||
| * [Writing bots](/api/writing-bots) | ||||
| @@ -1,77 +0,0 @@ | ||||
| {generate_api_header(/messages:post)} | ||||
|  | ||||
| ## Usage examples | ||||
|  | ||||
| {start_tabs} | ||||
|  | ||||
| {generate_code_example(python)|/messages:post|example} | ||||
|  | ||||
| {generate_code_example(javascript)|/messages:post|example} | ||||
|  | ||||
| {tab|curl} | ||||
|  | ||||
| ``` curl | ||||
| # For channel messages | ||||
| curl -X POST {{ api_url }}/v1/messages \ | ||||
|     -u BOT_EMAIL_ADDRESS:BOT_API_KEY \ | ||||
|     --data-urlencode type=stream \ | ||||
|     --data-urlencode 'to="Denmark"' \ | ||||
|     --data-urlencode topic=Castle \ | ||||
|     --data-urlencode 'content=I come not, friends, to steal away your hearts.' | ||||
|  | ||||
| # For direct messages | ||||
| curl -X POST {{ api_url }}/v1/messages \ | ||||
|     -u BOT_EMAIL_ADDRESS:BOT_API_KEY \ | ||||
|     --data-urlencode type=direct \ | ||||
|     --data-urlencode 'to=[9]' \ | ||||
|     --data-urlencode 'content=With mirth and laughter let old wrinkles come.' | ||||
| ``` | ||||
|  | ||||
| {tab|zulip-send} | ||||
|  | ||||
| You can use `zulip-send` | ||||
| (available after you `pip install zulip`) to easily send Zulips from | ||||
| the command-line, providing the message content via STDIN. | ||||
|  | ||||
| ```bash | ||||
| # For channel messages | ||||
| zulip-send --stream Denmark --subject Castle \ | ||||
|     --user othello-bot@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 | ||||
|  | ||||
| # For direct messages | ||||
| zulip-send hamlet@example.com \ | ||||
|     --user othello-bot@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 | ||||
| ``` | ||||
|  | ||||
| #### Passing in the message on the command-line | ||||
|  | ||||
| If you'd like, you can also provide the message on the command-line with the | ||||
| `-m` or `--message` flag, as follows: | ||||
|  | ||||
|  | ||||
| ```bash | ||||
| zulip-send --stream Denmark --subject Castle \ | ||||
|     --message 'I come not, friends, to steal away your hearts.' \ | ||||
|     --user othello-bot@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 | ||||
| ``` | ||||
|  | ||||
| You can omit the `user` and `api-key` parameters if you have a `~/.zuliprc` | ||||
| file. | ||||
|  | ||||
| {end_tabs} | ||||
|  | ||||
| ## Parameters | ||||
|  | ||||
| {generate_api_arguments_table|zulip.yaml|/messages:post} | ||||
|  | ||||
| {generate_parameter_description(/messages:post)} | ||||
|  | ||||
| ## Response | ||||
|  | ||||
| {generate_return_values_table|zulip.yaml|/messages:post} | ||||
|  | ||||
| {generate_response_description(/messages:post)} | ||||
|  | ||||
| #### Example response(s) | ||||
|  | ||||
| {generate_code_example|/messages:post|fixture} | ||||
| @@ -1,29 +0,0 @@ | ||||
| ## Integrations | ||||
|  | ||||
| * [Overview](/api/integrations-overview) | ||||
| * [Incoming webhook integrations](/api/incoming-webhooks-overview) | ||||
| * [Hello world walkthrough](/api/incoming-webhooks-walkthrough) | ||||
| * [Non-webhook integrations](/api/non-webhook-integrations) | ||||
|  | ||||
| ## Interactive bots (beta) | ||||
|  | ||||
| * [Running bots](/api/running-bots) | ||||
| * [Deploying bots](/api/deploying-bots) | ||||
| * [Writing bots](/api/writing-bots) | ||||
| * [Outgoing webhooks](/api/outgoing-webhooks) | ||||
|  | ||||
| ## REST API | ||||
|  | ||||
| * [Overview](/api/rest) | ||||
| * [Installation instructions](/api/installation-instructions) | ||||
| * [API keys](/api/api-keys) | ||||
| * [Configuring the Python bindings](/api/configuring-python-bindings) | ||||
| * [HTTP headers](/api/http-headers) | ||||
| * [Error handling](/api/rest-error-handling) | ||||
| * [Roles and permissions](/api/roles-and-permissions) | ||||
| * [Group-setting values](/api/group-setting-values) | ||||
| * [Message formatting](/api/message-formatting) | ||||
| * [Client libraries](/api/client-libraries) | ||||
| * [API changelog](/api/changelog) | ||||
|  | ||||
| {!rest-endpoints.md!} | ||||
							
								
								
									
										26
									
								
								babel.config.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										26
									
								
								babel.config.js
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,26 @@ | ||||
| "use strict"; | ||||
|  | ||||
| module.exports = { | ||||
|     plugins: [ | ||||
|         [ | ||||
|             "formatjs", | ||||
|             { | ||||
|                 additionalFunctionNames: ["$t", "$t_html"], | ||||
|                 overrideIdFn: (id, defaultMessage) => defaultMessage, | ||||
|             }, | ||||
|         ], | ||||
|     ], | ||||
|     presets: [ | ||||
|         [ | ||||
|             "@babel/preset-env", | ||||
|             { | ||||
|                 corejs: "3.6", | ||||
|                 loose: true, // Loose mode for…of loops are 5× faster in Firefox | ||||
|                 shippedProposals: true, | ||||
|                 useBuiltIns: "usage", | ||||
|             }, | ||||
|         ], | ||||
|         "@babel/typescript", | ||||
|     ], | ||||
|     sourceType: "unambiguous", | ||||
| }; | ||||
| @@ -3,6 +3,7 @@ from django.db import migrations, models | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("contenttypes", "0001_initial"), | ||||
|     ] | ||||
|   | ||||
| @@ -3,6 +3,7 @@ from django.db import migrations, models | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("confirmation", "0001_initial"), | ||||
|     ] | ||||
|   | ||||
| @@ -3,6 +3,7 @@ from django.db import migrations | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("confirmation", "0002_realmcreationkey"), | ||||
|     ] | ||||
|   | ||||
| @@ -3,6 +3,7 @@ from django.db import migrations, models | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("confirmation", "0003_emailchangeconfirmation"), | ||||
|     ] | ||||
|   | ||||
| @@ -4,6 +4,7 @@ from django.db import migrations, models | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("zerver", "0124_stream_enable_notifications"), | ||||
|         ("confirmation", "0004_remove_confirmationmanager"), | ||||
|   | ||||
| @@ -4,6 +4,7 @@ from django.db import migrations, models | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("confirmation", "0005_confirmation_realm"), | ||||
|     ] | ||||
|   | ||||
| @@ -4,6 +4,7 @@ from django.db import migrations, models | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("confirmation", "0006_realmcreationkey_presume_email_valid"), | ||||
|     ] | ||||
|   | ||||
| @@ -1,16 +0,0 @@ | ||||
| from django.db import migrations, models | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|     dependencies = [ | ||||
|         ("confirmation", "0007_add_indexes"), | ||||
|     ] | ||||
|  | ||||
|     operations = [ | ||||
|         migrations.AddField( | ||||
|             model_name="confirmation", | ||||
|             name="expiry_date", | ||||
|             field=models.DateTimeField(db_index=True, null=True), | ||||
|             preserve_default=False, | ||||
|         ), | ||||
|     ] | ||||
| @@ -1,70 +0,0 @@ | ||||
| # Generated by Django 3.1.7 on 2021-03-31 20:47 | ||||
|  | ||||
| import time | ||||
| from datetime import timedelta | ||||
|  | ||||
| from django.conf import settings | ||||
| from django.db import migrations, transaction | ||||
| from django.db.backends.base.schema import BaseDatabaseSchemaEditor | ||||
| from django.db.migrations.state import StateApps | ||||
|  | ||||
|  | ||||
| def set_expiry_date_for_existing_confirmations( | ||||
|     apps: StateApps, schema_editor: BaseDatabaseSchemaEditor | ||||
| ) -> None: | ||||
|     Confirmation = apps.get_model("confirmation", "Confirmation") | ||||
|     if not Confirmation.objects.exists(): | ||||
|         return | ||||
|  | ||||
|     # The values at the time of this migration | ||||
|     INVITATION = 2 | ||||
|     UNSUBSCRIBE = 4 | ||||
|     MULTIUSE_INVITE = 6 | ||||
|  | ||||
|     @transaction.atomic | ||||
|     def backfill_confirmations_between(lower_bound: int, upper_bound: int) -> None: | ||||
|         confirmations = Confirmation.objects.filter(id__gte=lower_bound, id__lte=upper_bound) | ||||
|         for confirmation in confirmations: | ||||
|             if confirmation.type in (INVITATION, MULTIUSE_INVITE): | ||||
|                 confirmation.expiry_date = confirmation.date_sent + timedelta( | ||||
|                     days=settings.INVITATION_LINK_VALIDITY_DAYS | ||||
|                 ) | ||||
|             elif confirmation.type == UNSUBSCRIBE: | ||||
|                 # Unsubscribe links never expire, which we apparently implement as in 1M days. | ||||
|                 confirmation.expiry_date = confirmation.date_sent + timedelta(days=1000000) | ||||
|             else: | ||||
|                 confirmation.expiry_date = confirmation.date_sent + timedelta( | ||||
|                     days=settings.CONFIRMATION_LINK_DEFAULT_VALIDITY_DAYS | ||||
|                 ) | ||||
|         Confirmation.objects.bulk_update(confirmations, ["expiry_date"]) | ||||
|  | ||||
|     # Because the ranges in this code are inclusive, subtracting 1 offers round numbers. | ||||
|     BATCH_SIZE = 1000 - 1 | ||||
|  | ||||
|     first_id = Confirmation.objects.earliest("id").id | ||||
|     last_id = Confirmation.objects.latest("id").id | ||||
|  | ||||
|     id_range_lower_bound = first_id | ||||
|     id_range_upper_bound = first_id + BATCH_SIZE | ||||
|     while id_range_lower_bound <= last_id: | ||||
|         print(f"Processed {id_range_lower_bound} / {last_id}") | ||||
|         backfill_confirmations_between(id_range_lower_bound, id_range_upper_bound) | ||||
|         id_range_lower_bound = id_range_upper_bound + 1 | ||||
|         id_range_upper_bound = id_range_lower_bound + BATCH_SIZE | ||||
|         time.sleep(0.1) | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|     atomic = False | ||||
|  | ||||
|     dependencies = [ | ||||
|         ("confirmation", "0008_confirmation_expiry_date"), | ||||
|     ] | ||||
|  | ||||
|     operations = [ | ||||
|         migrations.RunPython( | ||||
|             set_expiry_date_for_existing_confirmations, | ||||
|             reverse_code=migrations.RunPython.noop, | ||||
|             elidable=True, | ||||
|         ), | ||||
|     ] | ||||
| @@ -1,17 +0,0 @@ | ||||
| # Generated by Django 3.2.5 on 2021-08-02 19:03 | ||||
|  | ||||
| from django.db import migrations, models | ||||
|  | ||||
|  | ||||
| class Migration(migrations.Migration): | ||||
|     dependencies = [ | ||||
|         ("confirmation", "0009_confirmation_expiry_date_backfill"), | ||||
|     ] | ||||
|  | ||||
|     operations = [ | ||||
|         migrations.AlterField( | ||||
|             model_name="confirmation", | ||||
|             name="expiry_date", | ||||
|             field=models.DateTimeField(db_index=True), | ||||
|         ), | ||||
|     ] | ||||
Some files were not shown because too many files have changed in this diff Show More
		Reference in New Issue
	
	Block a user