Merge remote-tracking branch 'upstream/main' into f/pipelines-enhance…

…ment

.github/ISSUE_TEMPLATE/internal_techdebt.yml

@@ -0,0 +1,54 @@
+name: (Internal) Tech Debt Template
+description: Intended to help create internal tech debt change.
+title: "[Tech Debt]: "
+labels: ["kind/tech-debt"]
+body:
+  - type: dropdown
+    id: deploy-type
+    attributes:
+      label: Type
+      description: What kind of tech debt is it?
+      multiple: true
+      options:
+        - General Tech Debt (eg. Improve the way something exists today)
+        - Dev Efficiency (eg. CI improvements, issue templates, etc)
+        - Infrastructure (eg. Add web sockets)
+        - Quality (eg. tests)
+    validations:
+      required: true
+  - type: input
+    id: source
+    attributes:
+      label: Source
+      description: Where did you find this issue?
+      placeholder: main / feature branch x / incubation / etc
+    validations:
+      required: false
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: What should we improve?
+    validations:
+      required:
+        true
+  - type: textarea
+    id: why
+    attributes:
+      label: Why?
+      description: What value does this bring / what is it fixing?
+    validations:
+      required:
+        true
+  - type: textarea
+    id: anything-else
+    attributes:
+      label: Anything else?
+      description: |
+        Additional information. Suggested topics:
+        - Initial investigation
+        - Known impact this will cause
+        - Anything else you want to add
+    validations:
+      required:
+        false

.github/ISSUE_TEMPLATE/internal_tracker.yml

@@ -0,0 +1,64 @@
+name: (Internal) Tracker Template
+description: Intended to help with a template for tracking larger grouped items.
+title: "[Tracker]: "
+labels: ["tracker"]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A introductory description of the larger task
+    validations:
+      required:
+        true
+  - type: input
+    id: branch
+    attributes:
+      label: Target Branch
+      description: What is the feature branch to contain this effort? If not known at this time, replace with `TBD`
+      placeholder: f/
+    validations:
+      required: true
+  - type: textarea
+    id: requirements
+    attributes:
+      label: Requirements
+      description: A series of requirements to consider this tracker complete.
+      placeholder: |
+        * P0: Show something
+        * P2: Allow users to change permissions
+    validations:
+      required: true
+  - type: textarea
+    id: ux-issues
+    attributes:
+      label: Itemized UX Issues
+      description: |
+        List the tickets that UX will work on.
+
+        Tip: Using a bullet list will help display links to other tickets by unraveling the name and status of that ticket.
+      placeholder: |
+        * #1234
+        * Design mocks - Ticket TBD
+    validations:
+      required: true
+  - type: textarea
+    id: dev-issues
+    attributes:
+      label: Itemized Dev Issues
+      description: |
+        List the tickets that Development will work on. If unknown at this time, add `TBD`
+
+        Tip: Using a bullet list will help display links to other tickets by unraveling the name and status of that ticket.
+      placeholder: |
+        * #1234
+        * Implement Table Page - Ticket TBD
+    validations:
+      required: true
+  - type: textarea
+    id: artifacts
+    attributes:
+      label: Related artifacts
+      description: Any additional artifacts that will help with the tracker goals
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/internal_ux.yml

@@ -0,0 +1,53 @@
+name: (Internal) UX Template
+description: Intended to help ux create internal flows.
+title: "[UX]: "
+labels: ["kind/ux"]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A introductory description of the task
+    validations:
+      required:
+        true
+  - type: textarea
+    id: goals
+    attributes:
+      label: Goals
+      description: An itemized list of goals to complete for this ticket
+      placeholder: |
+        * Research...
+        * Design...
+    validations:
+      required: false
+  - type: textarea
+    id: output
+    attributes:
+      label: Expected Output
+      description: What would be considered the end result?
+    validations:
+      required: false
+  - type: textarea
+    id: related-issues
+    attributes:
+      label: Related Issues
+      description: |
+        Any related issues that might be useful to mention as it relates to this ticket's goals, expectations, or follow ups.
+
+        Tip: Using a bullet list will help display links to other tickets by unraveling the name and status of that ticket.
+      placeholder: |
+        * #1234
+        * Create figma designs - Ticket TBD
+    validations:
+      required: false
+  - type: textarea
+    id: artifacts
+    attributes:
+      label: Completed artifacts
+      description: |
+        Any artifacts you want to easily note as results of the effort.
+
+        Typically this is left empty at the start. Also useful to include useful links or information you would like to share for additional context.
+    validations:
+      required: false

backend/.eslintrc

@@ -35,6 +35,10 @@
   "settings": {
   },
   "rules": {
+    "no-restricted-properties": [ "error", {
+      "property": "toString",
+      "message": "e.toString() should be fastify.log.error(e, 'your string'). Other use-cases should avoid obj.toString() on principle. Craft the string you want instead."
+    }],
     "@typescript-eslint/explicit-function-return-type": "off",
     "@typescript-eslint/interface-name-prefix": "off",
     "@typescript-eslint/no-var-requires": "off",

backend/src/plugins/kube.ts

@@ -46,7 +46,10 @@ export default fp(async (fastify: FastifyInstance) => {
     );
     clusterID = (clusterVersion.body as { spec: { clusterID: string } }).spec.clusterID;
   } catch (e) {
-    fastify.log.error(`Failed to retrieve cluster id: ${e.response?.body?.message || e.message}.`);
+    fastify.log.error(
+      e,
+      `Failed to retrieve cluster id: ${e.response?.body?.message || e.message}.`,
+    );
   }
   let clusterBranding = 'okd';
   try {

backend/src/routes/api/cluster-settings/clusterSettingsUtils.ts

@@ -111,9 +111,7 @@ export const updateClusterSettings = async (
     }
     return { success: true, error: null };
   } catch (e) {
-    fastify.log.error(
-      'Setting cluster settings error: ' + e.toString() + e.response?.body?.message,
-    );
+    fastify.log.error(e, 'Setting cluster settings error: ' + e.response?.body?.message);
     if (e.response?.statusCode !== 404) {
       return { success: false, error: 'Unable to update cluster settings. ' + e.message };
     }
@@ -137,7 +135,7 @@ export const getClusterSettings = async (
       clusterSettings.userTrackingEnabled =
         segmentEnabledRes.body.data.segmentKeyEnabled === 'true';
     } catch (e) {
-      fastify.log.error('Error retrieving segment key enabled: ' + e.toString());
+      fastify.log.error(e, 'Error retrieving segment key enabled.');
     }
   }
   if (isJupyterEnabled) {
@@ -165,7 +163,7 @@ export const getClusterSettings = async (
         if (e.statusCode === 404) {
           fastify.log.warn('Notebook controller culling config not found, culling disabled...');
         } else {
-          fastify.log.error('Error getting notebook controller culling settings: ' + e.toString());
+          fastify.log.error(e, 'Error getting notebook controller culling settings.');
           throw e;
         }
       });
@@ -175,7 +173,7 @@ export const getClusterSettings = async (
       clusterSettings.pvcSize = pvcSize;
       clusterSettings.cullerTimeout = cullerTimeout;
     } catch (e) {
-      fastify.log.error('Error retrieving cluster settings: ' + e.toString());
+      fastify.log.error(e, 'Error retrieving cluster settings.');
     }
   }
 

backend/src/routes/api/dev-impersonate/index.ts

@@ -23,6 +23,8 @@ export default async (fastify: KubeFastifyInstance): Promise<void> => {
               url,
               {
                 headers: {
+                  // This usage of toString is fine for internal dev flows
+                  // eslint-disable-next-line no-restricted-properties
                   Authorization: `Basic ${Buffer.from(
                     `${DEV_IMPERSONATE_USER}:${DEV_IMPERSONATE_PASSWORD}`,
                   ).toString('base64')}`,

backend/src/routes/api/groups-config/groupsConfigUtil.ts

@@ -25,7 +25,7 @@ export const getGroupsConfig = async (fastify: KubeFastifyInstance): Promise<Gro
 
     return groupsConfigProcessed.groupsConfig;
   } catch (e) {
-    fastify.log.error('Error retrieving group configuration: ' + e.toString());
+    fastify.log.error(e, 'Error retrieving group configuration.');
     const error = createError(500, 'Error retrieving group configuration');
     throw error;
   }
@@ -74,7 +74,7 @@ export const updateGroupsConfig = async (
       error: null,
     };
   } catch (e) {
-    fastify.log.error('Error updating group configuration' + e.toString());
+    fastify.log.error(e, 'Error updating group configuration.');
     const error = createError(500, 'Error updating group configuration');
     throw error;
   }

backend/src/routes/api/images/imageUtils.ts

@@ -277,7 +277,7 @@ export const postImage = async (
     return { success: true, error: null };
   } catch (e) {
     if (e.response?.statusCode !== 404) {
-      fastify.log.error('Unable to add notebook image: ' + e.toString());
+      fastify.log.error(e, 'Unable to add notebook image');
       return { success: false, error: 'Unable to add notebook image: ' + e.message };
     }
   }
@@ -306,7 +306,7 @@ export const deleteImage = async (
     return { success: true, error: null };
   } catch (e) {
     if (e.response?.statusCode !== 404) {
-      fastify.log.error('Unable to delete notebook image: ' + e.toString());
+      fastify.log.error(e, 'Unable to delete notebook image.');
       return { success: false, error: 'Unable to delete notebook image: ' + e.message };
     }
   }
@@ -333,7 +333,7 @@ export const updateImage = async (
   );
 
   if (validName.length > 0) {
-    fastify.log.error('Duplicate name unable to add notebook image');
+    fastify.log.error('Duplicate name unable to add notebook image.');
     return { success: false, error: 'Unable to add notebook image: ' + body.name };
   }
 
@@ -397,7 +397,7 @@ export const updateImage = async (
     return { success: true, error: null };
   } catch (e) {
     if (e.response?.statusCode !== 404) {
-      fastify.log.error('Unable to update notebook image: ' + e.toString());
+      fastify.log.error(e, 'Unable to update notebook image.');
       return { success: false, error: 'Unable to update notebook image: ' + e.message };
     }
   }

backend/src/routes/api/nb-events/eventUtils.ts

@@ -4,15 +4,18 @@ import { KubeFastifyInstance } from '../../../types';
 export const getNotebookEvents = async (
   fastify: KubeFastifyInstance,
   namespace: string,
-  podUID: string,
+  notebookName: string,
+  podUID: string | undefined,
 ): Promise<V1Event[]> => {
   return fastify.kube.coreV1Api
     .listNamespacedEvent(
       namespace,
       undefined,
       undefined,
       undefined,
-      `involvedObject.kind=Pod,involvedObject.uid=${podUID}`,
+      podUID
+        ? `involvedObject.kind=Pod,involvedObject.uid=${podUID}`
+        : `involvedObject.kind=StatefulSet,involvedObject.name=${notebookName}`,
     )
     .then((res) => {
       const body = res.body as V1EventList;

backend/src/routes/api/nb-events/index.ts

@@ -3,24 +3,21 @@ import { getNotebookEvents } from './eventUtils';
 import { secureRoute } from '../../../utils/route-security';
 
 export default async (fastify: FastifyInstance): Promise<void> => {
-  fastify.get(
-    '/:namespace/:podUID',
-    secureRoute(fastify)(
-      async (
-        request: FastifyRequest<{
-          Params: {
-            namespace: string;
-            podUID: string;
-          };
-          Querystring: {
-            // TODO: Support server side filtering
-            from?: string;
-          };
-        }>,
-      ) => {
-        const { namespace, podUID } = request.params;
-        return getNotebookEvents(fastify, namespace, podUID);
-      },
-    ),
+  const routeHandler = secureRoute(fastify)(
+    async (
+      request: FastifyRequest<{
+        Params: {
+          namespace: string;
+          notebookName: string;
+          podUID: string | undefined;
+        };
+      }>,
+    ) => {
+      const { namespace, notebookName, podUID } = request.params;
+      return getNotebookEvents(fastify, namespace, notebookName, podUID);
+    },
   );
+
+  fastify.get('/:namespace/:notebookName', routeHandler);
+  fastify.get('/:namespace/:notebookName/:podUID', routeHandler);
 };

backend/src/routes/api/segment-key/segmentKeyUtils.ts

@@ -11,7 +11,7 @@ export const getSegmentKey = async (fastify: KubeFastifyInstance): Promise<ODHSe
     segmentKeyEnabled = resEnabled?.body.data?.segmentKeyEnabled === 'true';
     if (segmentKeyEnabled) {
       const res = await coreV1Api.readNamespacedSecret('odh-segment-key', namespace);
-      decodedSegmentKey = Buffer.from(res.body.data.segmentKey, 'base64').toString();
+      decodedSegmentKey = String(Buffer.from(res.body.data.segmentKey, 'base64'));
     } else {
       decodedSegmentKey = '';
     }

backend/src/server.ts

@@ -13,13 +13,25 @@ const transport =
     : undefined;
 
 const app = fastify({
-  logger: pino({ level: LOG_LEVEL }, transport),
+  logger: pino(
+    {
+      level: LOG_LEVEL,
+      redact: [
+        'err.response.request.headers.Authorization',
+        'response.request.headers.Authorization',
+        'request.headers.Authorization',
+        'headers.Authorization',
+        'Authorization',
+      ],
+    },
+    transport,
+  ),
   pluginTimeout: 10000,
 });
 
 app.register(initializeApp);
 
-app.listen({ port: PORT, host: IP}, (err) => {
+app.listen({ port: PORT, host: IP }, (err) => {
   if (err) {
     app.log.error(err);
     process.exit(1); // eslint-disable-line