feat - add possibility to share private snippets

via shareable link, similar to bookmarks sharing

Author: 4drianMatei

backend/src/model/snippet.js

@@ -13,6 +13,7 @@ const CodeSnippetSchema = new Schema({
 });
 
 const snippetSchema = new Schema({
+    shareableId: {type:String, select: false},
     title: {type:String, required: true},
     type: {type:String, required: true, default: 'snippet'},
     codeSnippets: [CodeSnippetSchema],

backend/src/routes/public/public-snippets.router.js

@@ -6,6 +6,17 @@ const SnippetsSearchService = require('../../common/snippets-search.service');
 const PublicSnippetsService = require('./public-snippets.service');
 
 const PaginationQueryParamsHelper = require('../../common/pagination-query-params-helper');
+const PublicBookmarksService = require("./public-bookmarks.service");
+
+/**
+ * Get snippet by shareableId
+ */
+router.get('/shared/:shareableId', async (request, response) => {
+  const shareableId = request.params.shareableId;
+  const sharedSnippet = await PublicSnippetsService.getSnippetBySharableId(shareableId);
+
+  return response.json(sharedSnippet);
+});
 
 /**
  *  Returns the with query text

backend/src/routes/public/public-snippets.service.js

@@ -81,7 +81,7 @@ let getMostUsedPublicTagsForSnippets = async function (limit) {
     },
 
     //
-    { $limit : limit }
+    {$limit: limit}
   ]);
 
   const usedTags = aggregatedTags.map(aggregatedTag => {
@@ -94,10 +94,24 @@ let getMostUsedPublicTagsForSnippets = async function (limit) {
   return usedTags;
 }
 
+/* GET snippet of user by shareableId */
+let getSnippetBySharableId = async (shareableId) => {
+  const snippet = await Snippet.findOne({
+    shareableId: shareableId
+  }).select('+shareableId');
+
+  if ( !snippet ) {
+    throw new NotFoundError(`Snippet NOT_FOUND for shareableId: ${shareableId}`);
+  } else {
+    return snippet;
+  }
+};
+
 
 module.exports = {
   getSnippetById: getSnippetById,
   getLatestPublicSnippets: getLatestPublicSnippets,
   getPublicSnippetsForTag: getPublicSnippetsForTag,
-  getMostUsedPublicTagsForSnippets: getMostUsedPublicTagsForSnippets
+  getMostUsedPublicTagsForSnippets: getMostUsedPublicTagsForSnippets,
+  getSnippetBySharableId: getSnippetBySharableId
 };

backend/src/routes/users/bookmarks/personal-bookmarks.service.js

@@ -13,6 +13,7 @@ const {
  */
 let createBookmark = async function (userId, bookmark) {
   BookmarkInputValidator.validateBookmarkInput(userId, bookmark);
+  bookmark.shareableId = undefined;
 
   await BookmarkInputValidator.verifyPublicBookmarkExistenceOnCreation(bookmark);
 
@@ -201,23 +202,28 @@ let getOrCreateShareableId = async (userId, bookmarkId) => {
       userId: userId
     }).select('+shareableId');
 
-  if ( bookmark.shareableId ) {
-    return bookmark.shareableId
-  } else {
-    const uuid = uuidv4();
-    const updatedBookmark = await Bookmark.findOneAndUpdate(
-      {
-        _id: bookmarkId,
-        userId: userId
-      },
-      {
-        $set: {shareableId: uuid}
-      },
-      {new: true}
-    ).select('+shareableId');
+  if ( bookmark ) {
+    if ( bookmark.shareableId ) {
+      return bookmark.shareableId
+    } else {
+      const uuid = uuidv4();
+      const updatedBookmark = await Bookmark.findOneAndUpdate(
+        {
+          _id: bookmarkId,
+          userId: userId
+        },
+        {
+          $set: {shareableId: uuid}
+        },
+        {new: true}
+      ).select('+shareableId');
 
-    return updatedBookmark.shareableId;
+      return updatedBookmark.shareableId;
+    }
+  } else {
+    throw new NotFoundError(`Bookmark NOT_FOUND the userId: ${userId} AND id: ${bookmarkId}`);
   }
+
 }
 
 

backend/src/routes/users/snippets/personal-snippets.router.js

@@ -66,6 +66,16 @@ personalSnippetsRouter.get('/export', keycloak.protect(), async (request, respon
   response.send(snippets);
 });
 
+/* GET sharableId for bookmark */
+personalSnippetsRouter.get('/shareable/:snippetId', keycloak.protect(), async (request, response) => {
+  UserIdValidator.validateUserId(request);
+
+  const {userId, snippetId} = request.params;
+  const shareableId = await PersonalSnippetsService.getOrCreateShareableId(userId, snippetId);
+  const sharableIdResponse = {"shareableId": shareableId}
+  return response.json(sharableIdResponse);
+});
+
 /**
  * Find personal snippets
  */

backend/src/routes/users/snippets/personal-snippets.service.js

@@ -3,14 +3,16 @@ const Snippet = require('../../../model/snippet');
 const NotFoundError = require('../../../error/not-found.error');
 
 const SnippetInputValidator = require('./snippet-input.validator');
+const {v4: uuidv4} = require("uuid");
 
 /**
  * CREATE snippet for user
  */
 let createSnippet = async function (userId, snippetData) {
   SnippetInputValidator.validateSnippetInput(userId, snippetData);
-
+  snippetData.shareableId = undefined;
   const snippet = new Snippet(snippetData);
+
   let newSnippet = await snippet.save();
 
   return newSnippet;
@@ -138,6 +140,35 @@ let getUserSnippetTags = async (userId) => {
   return userTags;
 };
 
+let getOrCreateShareableId = async (userId, snippetId) => {
+  const snippet = await Snippet.findOne(
+    {
+      _id: snippetId,
+      userId: userId
+    }).select('+shareableId');
+
+  if ( snippet ) {
+    if ( snippet.shareableId ) {
+      return snippet.shareableId
+    } else {
+      const uuid = uuidv4();
+      const updatedSnippet = await Snippet.findOneAndUpdate(
+        {
+          _id: snippetId,
+          userId: userId
+        },
+        {
+          $set: {shareableId: uuid}
+        },
+        {new: true}
+      ).select('+shareableId');
+
+      return updatedSnippet.shareableId;
+    }
+  } else {
+    throw new NotFoundError(`Snippet NOT_FOUND the userId: ${userId} AND id: ${snippetId}`);
+  }
+}
 
 module.exports = {
   createSnippet: createSnippet,
@@ -148,4 +179,5 @@ module.exports = {
   getAllMySnippets: getAllMySnippets,
   updateSnippet: updateSnippet,
   deleteSnippetById: deleteSnippetById,
+  getOrCreateShareableId: getOrCreateShareableId
 };

documentation/temp/to-do.md

@@ -5,3 +5,14 @@
   * add extensive integration tests for search
 * verify "copy snippet" and show more for (longer snippets see https://www.codever.dev/?q=angular%20custom%20route&sd=my-snippets&page=1&tab=search-results)
 * remove duplicate code in search services (OR search mode)
+* 
+* verify for bookmarks
+  <button *ngIf="snippet.public || (!snippet.public && snippet.userId === observables.userId)"
+  class="btn btn-light btn-sm float-right"
+  title="Share via email or on social media"
+  (click)="shareSnippetDialog(snippet, observables.userIsLoggedIn, observables.userId)"><i class="fas fa-share"></i> Share
+  </button>
+
+* error userinfo in console network when NOT logged in http://localhost:4200/snippets/shared/0a77563c-afed-4b01-af83-52348653e844
+
+* public snippets test not working - see console (results are present but not shown and public bookmarks are searched in...)

frontend/README.md

@@ -45,6 +45,6 @@ Run `ng build` to build the project. The build artifacts will be stored in the `
 
 I use an alias for that
 ```shell
-alias bookmarks-build-aot='cd ~/projects/dev/personal/bookmarks/bookmarks.dev/frontend; rm -rf dist*; nvm use; npm run build:aot'
+alias codever-build-aot='cd ~/projects/dev/personal/codever/codever/frontend; rm -rf dist*; nvm use; npm run build:aot'
 ```
 

frontend/src/app/core/model/snippet.ts

@@ -1,5 +1,6 @@
 export interface Snippet {
   _id?: string;
+  shareableId?: string;
   type: string; // should always by 'snippet'
   title: string;
   codeSnippets: CodeSnippet[];

frontend/src/app/core/personal-snippets.service.ts

@@ -97,4 +97,10 @@ export class PersonalSnippetsService {
     return this.httpClient.get<Snippet[]>(`${this.personalSnippetsApiBaseUrl}/${userId}/snippets/export`)
       .pipe(shareReplay(1));
   }
+
+  createOrGetShareableId(userId: string, snippetId: string): Observable<any> {
+    return this.httpClient
+      .get<string>(`${this.personalSnippetsApiBaseUrl}/${userId}/snippets/shareable/${snippetId}`)
+      .pipe(shareReplay(1));
+  }
 }