DEV: Start renaming cookAsync() function to cook() (#23462)

Some time ago, we introduced the `cookAsync` instead of the existing 
`cook` function, and planned to migrate everything to it. Then after 
migrating, we wanted to raname the function to simply `cook`.

I've checked Core and plugins, and currently we call `cookAsync` everywhere, 
there are no calls to the `cook` function anymore. So we're good 
to proceed with this refactoring.

This PR makes the first step by making current cookAsync and cook functions 
do the same thing. Effectively now the `cook` function becomes an alias 
for the `cookAsync` function.

app/assets/javascripts/discourse/app/components/cook-text.gjs

@@ -4,7 +4,7 @@ import didUpdate from "@ember/render-modifiers/modifiers/did-update";
 import { action } from "@ember/object";
 import { tracked } from "@glimmer/tracking";
 import { loadOneboxes } from "discourse/lib/load-oneboxes";
-import { cookAsync } from "discourse/lib/text";
+import { cook } from "discourse/lib/text";
 import { resolveAllShortUrls } from "pretty-text/upload-short-url";
 import { ajax } from "discourse/lib/ajax";
 
@@ -32,7 +32,7 @@ export default class CookText extends Component {
 
   @action
   async loadCookedText() {
-    const cooked = await cookAsync(this.args.rawText);
+    const cooked = await cook(this.args.rawText);
     this.cooked = cooked;
   }
 

app/assets/javascripts/discourse/app/components/modal/change-post-notice.js

@@ -1,7 +1,7 @@
 import Component from "@glimmer/component";
 import { tracked } from "@glimmer/tracking";
 import { action } from "@ember/object";
-import { cookAsync } from "discourse/lib/text";
+import { cook } from "discourse/lib/text";
 import { isEmpty } from "@ember/utils";
 
 export default class ChangePostNoticeModal extends Component {
@@ -42,7 +42,7 @@ export default class ChangePostNoticeModal extends Component {
       .updatePostField("notice", notice)
       .then(() => {
         if (notice) {
-          return cookAsync(notice, { features: { onebox: false } });
+          return cook(notice, { features: { onebox: false } });
         }
       })
       .then((cooked) =>

app/assets/javascripts/discourse/app/components/summary-box.js

@@ -5,7 +5,7 @@ import { inject as service } from "@ember/service";
 import { action } from "@ember/object";
 import { ajax } from "discourse/lib/ajax";
 import { popupAjaxError } from "discourse/lib/ajax-error";
-import { cookAsync } from "discourse/lib/text";
+import { cook } from "discourse/lib/text";
 import { shortDateNoYear } from "discourse/lib/formatter";
 import { bind } from "discourse-common/utils/decorators";
 
@@ -44,7 +44,7 @@ export default class SummaryBox extends Component {
     const topicSummary = update.topic_summary;
 
     if (topicSummary.summarized_text) {
-      cookAsync(topicSummary.summarized_text).then((cooked) => {
+      cook(topicSummary.summarized_text).then((cooked) => {
         this.summary = cooked;
       });
     }

app/assets/javascripts/discourse/app/controllers/preferences/profile.js

@@ -2,7 +2,7 @@ import Controller from "@ember/controller";
 import EmberObject, { action } from "@ember/object";
 import I18n from "I18n";
 import { ajax } from "discourse/lib/ajax";
-import { cookAsync } from "discourse/lib/text";
+import { cook } from "discourse/lib/text";
 import discourseComputed from "discourse-common/utils/decorators";
 import { isEmpty } from "@ember/utils";
 import { popupAjaxError } from "discourse/lib/ajax-error";
@@ -128,7 +128,7 @@ export default Controller.extend({
       return model
         .save(this.saveAttrNames)
         .then(() => {
-          cookAsync(model.get("bio_raw"))
+          cook(model.get("bio_raw"))
             .then(() => {
               model.set("bio_cooked");
               this.set("saved", true);

app/assets/javascripts/discourse/app/lib/text.js

@@ -10,6 +10,7 @@ import { htmlSafe } from "@ember/template";
 import loadScript from "discourse/lib/load-script";
 import { sanitize as textSanitize } from "pretty-text/sanitizer";
 import { MentionsParser } from "discourse/lib/mentions-parser";
+import deprecated from "discourse-common/lib/deprecated";
 
 function getOpts(opts) {
   let context = helperContext();
@@ -33,15 +34,21 @@ function getOpts(opts) {
   return buildOptions(opts);
 }
 
-// Use this to easily create a pretty text instance with proper options
 export function cook(text, options) {
-  return htmlSafe(createPrettyText(options).cook(text));
+  return loadMarkdownIt().then(() => {
+    const cooked = createPrettyText(options).cook(text);
+    return htmlSafe(cooked);
+  });
 }
 
-// everything should eventually move to async API and this should be renamed
+// todo drop this function after migrating everything to cook()
-// cook
 export function cookAsync(text, options) {
-  return loadMarkdownIt().then(() => cook(text, options));
+  deprecated("cookAsync() is deprecated, call cook() instead", {
+    since: "3.2.0.beta2",
+    dropFrom: "3.2.0.beta5",
+    id: "discourse.text.cook-async",
+  });
+  return cook(text, options);
 }
 
 // Warm up pretty text with a set of options and return a function

app/assets/javascripts/discourse/app/models/pending-post.js

@@ -3,7 +3,7 @@ import RestModel from "discourse/models/rest";
 import categoryFromId from "discourse-common/utils/category-macro";
 import { userPath } from "discourse/lib/url";
 import { reads } from "@ember/object/computed";
-import { cookAsync } from "discourse/lib/text";
+import { cook } from "discourse/lib/text";
 
 const PendingPost = RestModel.extend({
   expandedExcerpt: null,
@@ -12,7 +12,7 @@ const PendingPost = RestModel.extend({
 
   init() {
     this._super(...arguments);
-    cookAsync(this.raw_text).then((cooked) => {
+    cook(this.raw_text).then((cooked) => {
       this.set("expandedExcerpt", cooked);
     });
   },

app/assets/javascripts/discourse/app/models/post.js

@@ -8,7 +8,7 @@ import RestModel from "discourse/models/rest";
 import Site from "discourse/models/site";
 import User from "discourse/models/user";
 import { ajax } from "discourse/lib/ajax";
-import { cookAsync } from "discourse/lib/text";
+import { cook } from "discourse/lib/text";
 import discourseComputed from "discourse-common/utils/decorators";
 import { fancyTitle } from "discourse/lib/topic-fancy-title";
 import { isEmpty } from "@ember/utils";
@@ -217,7 +217,7 @@ const Post = RestModel.extend({
         this.post_number === 1
           ? "topic.deleted_by_author_simple"
           : "post.deleted_by_author_simple";
-      promise = cookAsync(I18n.t(key)).then((cooked) => {
+      promise = cook(I18n.t(key)).then((cooked) => {
         this.setProperties({
           cooked,
           can_delete: false,

app/assets/javascripts/discourse/app/models/user-drafts-stream.js

@@ -1,6 +1,6 @@
 import discourseComputed from "discourse-common/utils/decorators";
 import { ajax } from "discourse/lib/ajax";
-import { cookAsync, emojiUnescape, excerpt } from "discourse/lib/text";
+import { cook, emojiUnescape, excerpt } from "discourse/lib/text";
 import { escapeExpression } from "discourse/lib/utilities";
 import {
   NEW_PRIVATE_MESSAGE_KEY,
@@ -68,7 +68,7 @@ export default RestModel.extend({
 
         const promises = result.drafts.map((draft) => {
           draft.data = JSON.parse(draft.data);
-          return cookAsync(draft.data.reply).then((cooked) => {
+          return cook(draft.data.reply).then((cooked) => {
             draft.excerpt = excerpt(cooked.toString(), 300);
             draft.post_number = draft.data.postId || null;
             if (

app/assets/javascripts/discourse/tests/unit/lib/text-test.js

@@ -1,11 +1,6 @@
 import { module, test } from "qunit";
 import { setupTest } from "ember-qunit";
-import {
+import { cook, excerpt, parseAsync, parseMentions } from "discourse/lib/text";
-  cookAsync,
-  excerpt,
-  parseAsync,
-  parseMentions,
-} from "discourse/lib/text";
 
 module("Unit | Utility | text", function (hooks) {
   setupTest(hooks);
@@ -21,22 +16,22 @@ module("Unit | Utility | text", function (hooks) {
   });
 
   test("excerpt", async function (assert) {
-    let cooked = await cookAsync("Hello! :wave:");
+    let cooked = await cook("Hello! :wave:");
     assert.strictEqual(
       await excerpt(cooked, 300),
       'Hello! <img src="/images/emoji/twitter/wave.png?v=12" title=":wave:" class="emoji" alt=":wave:" loading="lazy" width="20" height="20">'
     );
 
-    cooked = await cookAsync("[:wave:](https://example.com)");
+    cooked = await cook("[:wave:](https://example.com)");
     assert.strictEqual(
       await excerpt(cooked, 300),
       '<a href="https://example.com"><img src="/images/emoji/twitter/wave.png?v=12" title=":wave:" class="emoji only-emoji" alt=":wave:" loading="lazy" width="20" height="20"></a>'
     );
 
-    cooked = await cookAsync('<script>alert("hi")</script>');
+    cooked = await cook('<script>alert("hi")</script>');
     assert.strictEqual(await excerpt(cooked, 300), "");
 
-    cooked = await cookAsync("[`<script>alert('hi')</script>`]()");
+    cooked = await cook("[`<script>alert('hi')</script>`]()");
     assert.strictEqual(
       await excerpt(cooked, 300),
       "<a><code>&lt;script&gt;alert('hi')&lt;/script&gt;</code></a>"

plugins/checklist/test/javascripts/lib/checklist-test.js

@@ -1,6 +1,6 @@
 import { acceptance } from "discourse/tests/helpers/qunit-helpers";
 import { test } from "qunit";
-import { cookAsync } from "discourse/lib/text";
+import { cook } from "discourse/lib/text";
 import Post from "discourse/models/post";
 import { checklistSyntax } from "discourse/plugins/checklist/discourse/initializers/checklist";
 import { Promise } from "rsvp";
@@ -8,7 +8,7 @@ import { Promise } from "rsvp";
 let currentRaw;
 
 async function prepare(raw) {
-  const cooked = await cookAsync(raw, {
+  const cooked = await cook(raw, {
     siteSettings: { checklist_enabled: true },
   });
 

plugins/discourse-local-dates/assets/javascripts/discourse/components/modal/local-dates-create.js

@@ -6,7 +6,7 @@ import Component from "@ember/component";
 import EmberObject, { action } from "@ember/object";
 import I18n from "I18n";
 import { INPUT_DELAY } from "discourse-common/config/environment";
-import { cookAsync } from "discourse/lib/text";
+import { cook } from "discourse/lib/text";
 import { notEmpty } from "@ember/object/computed";
 import { propertyNotEqual } from "discourse/lib/computed";
 import { schedule } from "@ember/runloop";
@@ -59,7 +59,7 @@ export default Component.extend({
   @debounce(INPUT_DELAY)
   async _renderPreview() {
     if (this.markup) {
-      const result = await cookAsync(this.markup);
+      const result = await cook(this.markup);
       this.set("currentPreview", result);
 
       schedule("afterRender", () => {

plugins/styleguide/assets/javascripts/discourse/components/styleguide-markdown.js

@@ -1,13 +1,11 @@
 import Component from "@ember/component";
-import { cookAsync } from "discourse/lib/text";
+import { cook } from "discourse/lib/text";
 
 export default Component.extend({
   didInsertElement() {
     this._super(...arguments);
 
     const contents = $(this.element).html();
-    cookAsync(contents).then((cooked) =>
+    cook(contents).then((cooked) => $(this.element).html(cooked.toString()));
-      $(this.element).html(cooked.toString())
-    );
   },
 });