ability to share jobs with users

orangecoding · orangecoding · commit 33120ebecaf9 · 2025-10-07T21:06:59.000+02:00
diff --git a/lib/api/routes/jobRouter.js b/lib/api/routes/jobRouter.js
@@ -24,9 +24,25 @@ function doesJobBelongsToUser(job, req) {
 jobRouter.get('/', async (req, res) => {
   const isUserAdmin = isAdmin(req);
   //show only the jobs which belongs to the user (or all of the user is an admin)
-  res.body = jobStorage.getJobs().filter((job) => isUserAdmin || job.userId === req.session.currentUser);
+  res.body = jobStorage
+    .getJobs()
+    .filter(
+      (job) =>
+        isUserAdmin || job.userId === req.session.currentUser || job.shared_with_user.includes(req.session.currentUser),
+    )
+    .map((job) => {
+      return {
+        ...job,
+        isOnlyShared:
+          !isUserAdmin &&
+          job.userId !== req.session.currentUser &&
+          job.shared_with_user.includes(req.session.currentUser),
+      };
+    });
+
   res.send();
 });
+
 jobRouter.get('/processingTimes', async (req, res) => {
   res.body = {
     interval: config.interval,
@@ -41,8 +57,15 @@ jobRouter.post('/startAll', async (req, res) => {
 });
 
 jobRouter.post('/', async (req, res) => {
-  const { provider, notificationAdapter, name, blacklist = [], jobId, enabled } = req.body;
+  const { provider, notificationAdapter, name, blacklist = [], jobId, enabled, shareWithUsers = [] } = req.body;
   try {
+    let jobFromDb = jobStorage.getJob(jobId);
+
+    if (jobFromDb && !doesJobBelongsToUser(jobFromDb, req)) {
+      res.send(new Error('You are trying to change a job that is not associated to your user.'));
+      return;
+    }
+
     jobStorage.upsertJob({
       userId: req.session.currentUser,
       jobId,
@@ -51,13 +74,15 @@ jobRouter.post('/', async (req, res) => {
       blacklist,
       provider,
       notificationAdapter,
+      shareWithUsers,
     });
   } catch (error) {
     res.send(new Error(error));
     logger.error(error);
   }
   res.send();
 });
+
 jobRouter.delete('', async (req, res) => {
   const { jobId } = req.body;
   try {
@@ -92,4 +117,16 @@ jobRouter.put('/:jobId/status', async (req, res) => {
   }
   res.send();
 });
+
+jobRouter.get('/shareableUserList', async (req, res) => {
+  const currentUser = req.session.currentUser;
+  const users = userStorage.getUsers(false);
+  res.body = users
+    .filter((user) => !user.isAdmin && user.id !== currentUser)
+    .map((user) => ({
+      id: user.id,
+      name: user.username,
+    }));
+  res.send();
+});
 export { jobRouter };
diff --git a/lib/api/routes/userRoute.js b/lib/api/routes/userRoute.js
@@ -11,10 +11,12 @@ function checkIfUserToBeRemovedIsLoggedIn(userIdToBeRemoved, req) {
   return req.session.currentUser === userIdToBeRemoved;
 }
 const nullOrEmpty = (str) => str == null || str.length === 0;
+
 userRouter.get('/', async (req, res) => {
   res.body = userStorage.getUsers(false);
   res.send();
 });
+
 userRouter.get('/:userId', async (req, res) => {
   const { userId } = req.params;
   res.body = userStorage.getUser(userId);
diff --git a/lib/services/storage/jobStorage.js b/lib/services/storage/jobStorage.js
@@ -16,7 +16,16 @@ import { toJson, fromJson } from '../../utils.js';
  * @param {string} params.userId - Owner user id for inserts; preserved on updates.
  * @returns {void}
  */
-export const upsertJob = ({ jobId, name, blacklist = [], enabled = true, provider, notificationAdapter, userId }) => {
+export const upsertJob = ({
+  jobId,
+  name,
+  blacklist = [],
+  enabled = true,
+  provider,
+  notificationAdapter,
+  userId,
+  shareWithUsers = [],
+}) => {
   const id = jobId || nanoid();
   const existing = SqliteConnection.query(`SELECT id, user_id FROM jobs WHERE id = @id LIMIT 1`, { id })[0];
   const ownerId = existing ? existing.user_id : userId;
@@ -27,28 +36,31 @@ export const upsertJob = ({ jobId, name, blacklist = [], enabled = true, provide
              name = @name,
              blacklist = @blacklist,
              provider = @provider,
-             notification_adapter = @notification_adapter
+             notification_adapter = @notification_adapter,
+             shared_with_user = @shareWithUsers
        WHERE id = @id`,
       {
         id,
         enabled: enabled ? 1 : 0,
         name: name ?? null,
         blacklist: toJson(blacklist ?? []),
+        shareWithUsers: toJson(shareWithUsers ?? []),
         provider: toJson(provider ?? []),
         notification_adapter: toJson(notificationAdapter ?? []),
       },
     );
   } else {
     SqliteConnection.execute(
-      `INSERT INTO jobs (id, user_id, enabled, name, blacklist, provider, notification_adapter)
-       VALUES (@id, @user_id, @enabled, @name, @blacklist, @provider, @notification_adapter)`,
+      `INSERT INTO jobs (id, user_id, enabled, name, blacklist, provider, notification_adapter, shared_with_user)
+       VALUES (@id, @user_id, @enabled, @name, @blacklist, @provider, @notification_adapter, @shareWithUsers)`,
       {
         id,
         user_id: ownerId,
         enabled: enabled ? 1 : 0,
         name: name ?? null,
         blacklist: toJson(blacklist ?? []),
         provider: toJson(provider ?? []),
+        shareWithUsers: toJson(shareWithUsers ?? []),
         notification_adapter: toJson(notificationAdapter ?? []),
       },
     );
@@ -129,6 +141,7 @@ export const getJobs = () => {
             j.name,
             j.blacklist,
             j.provider,
+            j.shared_with_user,
             j.notification_adapter AS notificationAdapter,
             (SELECT COUNT(1) FROM listings l WHERE l.job_id = j.id) AS numberOfFoundListings
        FROM jobs j
@@ -139,6 +152,7 @@ export const getJobs = () => {
     enabled: !!row.enabled,
     blacklist: fromJson(row.blacklist, []),
     provider: fromJson(row.provider, []),
+    shared_with_user: fromJson(row.shared_with_user, []),
     notificationAdapter: fromJson(row.notificationAdapter, []),
   }));
 };
diff --git a/lib/services/storage/migrations/sql/5.job-sharing.js b/lib/services/storage/migrations/sql/5.job-sharing.js
@@ -0,0 +1,7 @@
+// Migration: Adding a new table to store if somebody "watches" (a.k.a favorite) a listing
+
+export function up(db) {
+  db.exec(`
+    ALTER TABLE jobs ADD COLUMN shared_with_user jsonb DEFAULT '[]'
+  `);
+}
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "fredy",
-  "version": "14.1.1",
+  "version": "14.2.0",
   "description": "[F]ind [R]eal [E]states [d]amn eas[y].",
   "scripts": {
     "prepare": "husky",
@@ -85,7 +85,7 @@
     "react-router": "7.9.3",
     "react-router-dom": "7.9.3",
     "restana": "5.1.0",
-    "semver": "^7.7.2",
+    "semver": "^7.7.3",
     "serve-static": "2.2.0",
     "slack": "11.0.2",
     "vite": "7.1.9",
@@ -98,13 +98,13 @@
     "@babel/preset-env": "7.28.3",
     "@babel/preset-react": "7.27.1",
     "chai": "6.2.0",
-    "eslint": "9.36.0",
+    "eslint": "9.37.0",
     "eslint-config-prettier": "10.1.8",
     "eslint-plugin-react": "7.37.5",
     "esmock": "2.7.3",
     "history": "5.3.0",
     "husky": "9.1.7",
-    "less": "4.4.1",
+    "less": "4.4.2",
     "lint-staged": "16.2.3",
     "mocha": "11.7.4",
     "nodemon": "^3.1.10",
diff --git a/ui/src/App.jsx b/ui/src/App.jsx
@@ -37,6 +37,7 @@ export default function FredyApp() {
         await actions.provider.getProvider();
         await actions.jobs.getJobs();
         await actions.jobs.getProcessingTimes();
+        await actions.jobs.getSharableUserList();
         await actions.notificationAdapter.getAdapter();
         await actions.generalSettings.getGeneralSettings();
         await actions.versionUpdate.getVersionUpdate();
diff --git a/ui/src/components/table/JobTable.jsx b/ui/src/components/table/JobTable.jsx
@@ -1,7 +1,7 @@
 import React from 'react';
 
 import { Button, Empty, Table, Switch, Popover } from '@douyinfe/semi-ui';
-import { IconDelete, IconDescend2, IconEdit, IconHistogram } from '@douyinfe/semi-icons';
+import { IconAlertTriangle, IconDelete, IconDescend2, IconEdit, IconHistogram } from '@douyinfe/semi-icons';
 import { IllustrationNoResult, IllustrationNoResultDark } from '@douyinfe/semi-illustrations';
 
 import './JobTable.less';
@@ -33,12 +33,38 @@ export default function JobTable({
           title: '',
           dataIndex: '',
           render: (job) => {
-            return <Switch onChange={(checked) => onJobStatusChanged(job.id, checked)} checked={job.enabled} />;
+            return (
+              <Switch
+                onChange={(checked) => onJobStatusChanged(job.id, checked)}
+                checked={job.enabled}
+                disabled={job.isOnlyShared}
+              />
+            );
           },
         },
         {
           title: 'Name',
           dataIndex: 'name',
+          render: (name, job) => {
+            if (job.isOnlyShared) {
+              return (
+                <Popover
+                  content={getPopoverContent(
+                    'This job has been shared with you by another user, therefor it is read-only.',
+                  )}
+                >
+                  <div style={{ display: 'flex', gap: '.3rem' }}>
+                    <div style={{ color: 'rgba(var(--semi-yellow-7), 1)' }}>
+                      <IconAlertTriangle />
+                    </div>
+                    {name}
+                  </div>
+                </Popover>
+              );
+            } else {
+              return name;
+            }
+          },
         },
         {
           title: 'Listings',
@@ -48,14 +74,14 @@ export default function JobTable({
           },
         },
         {
-          title: 'Providers',
+          title: 'Provider',
           dataIndex: 'provider',
           render: (value) => {
             return value.length || 0;
           },
         },
         {
-          title: 'Notification adapters',
+          title: 'Notification Adapter',
           dataIndex: 'notificationAdapter',
           render: (value) => {
             return value.length || 0;
@@ -68,16 +94,36 @@ export default function JobTable({
             return (
               <div className="interactions">
                 <Popover content={getPopoverContent('Job Insights')}>
-                  <Button type="primary" icon={<IconHistogram />} onClick={() => onJobInsight(job.id)} />
+                  <Button
+                    type="primary"
+                    icon={<IconHistogram />}
+                    disabled={job.isOnlyShared}
+                    onClick={() => onJobInsight(job.id)}
+                  />
                 </Popover>
                 <Popover content={getPopoverContent('Edit a Job')}>
-                  <Button type="secondary" icon={<IconEdit />} onClick={() => onJobEdit(job.id)} />
+                  <Button
+                    type="secondary"
+                    icon={<IconEdit />}
+                    disabled={job.isOnlyShared}
+                    onClick={() => onJobEdit(job.id)}
+                  />
                 </Popover>
                 <Popover content={getPopoverContent('Delete all found Listings of this Job')}>
-                  <Button type="danger" icon={<IconDescend2 />} onClick={() => onListingRemoval(job.id)} />
+                  <Button
+                    type="danger"
+                    icon={<IconDescend2 />}
+                    disabled={job.isOnlyShared}
+                    onClick={() => onListingRemoval(job.id)}
+                  />
                 </Popover>
                 <Popover content={getPopoverContent('Delete Job')}>
-                  <Button type="danger" icon={<IconDelete />} onClick={() => onJobRemoval(job.id)} />
+                  <Button
+                    type="danger"
+                    icon={<IconDelete />}
+                    disabled={job.isOnlyShared}
+                    onClick={() => onJobRemoval(job.id)}
+                  />
                 </Popover>
               </div>
             );
diff --git a/ui/src/components/table/listings/ListingsFilter.jsx b/ui/src/components/table/listings/ListingsFilter.jsx
@@ -26,7 +26,11 @@ export default function ListingsFilter({ onWatchListFilter, onActivityFilter, on
             {jobs != null &&
               jobs.length > 0 &&
               jobs.map((job) => {
-                return <Select.Option value={job.id}>{job.name}</Select.Option>;
+                return (
+                  <Select.Option value={job.id} key={job.id}>
+                    {job.name}
+                  </Select.Option>
+                );
               })}
           </Select>
         </Descriptions.Item>
@@ -35,7 +39,11 @@ export default function ListingsFilter({ onWatchListFilter, onActivityFilter, on
             {provider != null &&
               provider.length > 0 &&
               provider.map((prov) => {
-                return <Select.Option value={prov.id}>{prov.name}</Select.Option>;
+                return (
+                  <Select.Option value={prov.id} key={prov.id}>
+                    {prov.name}
+                  </Select.Option>
+                );
               })}
           </Select>
         </Descriptions.Item>
diff --git a/ui/src/services/state/store.js b/ui/src/services/state/store.js
@@ -67,6 +67,14 @@ export const useFredyState = create(
               console.error(`Error while trying to get resource for api/jobs. Error:`, Exception);
             }
           },
+          async getSharableUserList() {
+            try {
+              const response = await xhrGet('/api/jobs/shareableUserList');
+              set((state) => ({ jobs: { ...state.jobs, shareableUserList: Object.freeze(response.json) } }));
+            } catch (Exception) {
+              console.error(`Error while trying to get resource for api/jobs. Error:`, Exception);
+            }
+          },
           async getProcessingTimes() {
             try {
               const response = await xhrGet('/api/jobs/processingTimes');
@@ -172,7 +180,7 @@ export const useFredyState = create(
         demoMode: { demoMode: false },
         versionUpdate: {},
         provider: [],
-        jobs: { jobs: [], insights: {}, processingTimes: {} },
+        jobs: { jobs: [], insights: {}, processingTimes: {}, shareableUserList: [] },
         user: { users: [], currentUser: null },
       };
 
diff --git a/ui/src/views/jobs/mutation/JobMutation.jsx b/ui/src/views/jobs/mutation/JobMutation.jsx
diff --git a/yarn.lock b/yarn.lock
